squad-conventions

Apply Squad codebase conventions to Node.js CLI projects using Node.js built-ins and node:test.

619|188|Updated Jul 4, 2024
One-click install
npx skills add https://github.com/CommunityToolkit/Aspire --skill squad-conventions-communitytoolkit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: squad-conventions
Source: https://github.com/CommunityToolkit/Aspire/tree/main/examples/squad/CommunityToolkit.Aspire.Hosting.Squad.AppHost/dev-squad/.copilot/skills/squad-conventions
Command: npx skills add https://github.com/CommunityToolkit/Aspire --skill squad-conventions-communitytoolkit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that your code adheres to the established conventions and patterns in the Squad codebase, simplifying the process of modifying or contributing to the Squad CLI tool.

Core Features & Use Cases

  • Core Conventions: Provides the essential coding conventions and patterns used in the Squad codebase.
  • Domain-Specific: Applicable to the Squad CLI tool (create-squad).
  • Zero Dependencies: Utilizes Node.js built-ins for error handling, file paths, and more.
  • Test Runner Integration: Uses node:test for testing without additional frameworks.

Quick Start

Use this skill to implement coding conventions in your Squad CLI tool projects.

Frequently Asked Questions about squad-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce coding conventions in a Node.js CLI project without external dependencies?

You can enforce coding conventions in a Node.js CLI project by using built-in modules for zero-dependency error handling and path management, ensuring the codebase remains lightweight and compliant without requiring external libraries.

Can I use node:test for unit testing a Node.js CLI tool without additional testing frameworks?

Yes, you can use the built-in node:test module for unit testing your Node.js CLI tool without installing additional testing frameworks, keeping your project dependencies at zero while maintaining test coverage.

What are the core Squad CLI coding conventions for error handling and path management?

The core Squad CLI coding conventions require using Node.js built-ins for zero-dependency error handling and path management, ensuring all file operations and errors are processed without relying on external packages.

Does the Squad CLI convention require zero dependencies for Node.js projects?

Yes, the Squad CLI convention requires zero dependencies for Node.js projects, utilizing only Node.js built-in modules to handle errors, file paths, and testing to maintain a minimal and secure codebase.

How do I start contributing to the Squad CLI codebase with the correct coding patterns?

To start contributing to the Squad CLI codebase, apply the established coding conventions by utilizing Node.js built-ins for path management and error handling, and run tests using the native node:test module.

What is the best way to handle file paths in a Node.js CLI tool following Squad conventions?

The best way to handle file paths in a Node.js CLI tool following Squad conventions is to use Node.js built-in path modules directly, ensuring zero-dependency path management that aligns with the codebase patterns.