What problem does it solve?
This Skill provides the core conventions and patterns of the Squad codebase, enabling developers to understand and adhere to the Squad CLI tool's coding standards.
Core Features & Use Cases
- Zero Dependencies: Emphasizes using Node.js built-ins and avoiding external package dependencies.
- Node.js Built-in Test Runner: Utilizes
node:test and node:assert/strict for testing without frameworks.
- Error Handling: Implements a
fatal() function for user-facing errors, ensuring consistent error messages.
- ANSI Color Constants: Defines color constants for consistent use in console output.
- File Structure: Outlines the ideal structure for the Squad CLI tool, including team state, templates, and skills.
- Windows Compatibility: Ensures compatibility across Windows, macOS, and Linux platforms.
- Init Idempotency: Ensures that the init flow does not overwrite user state.
- Copy Pattern: Provides a
copyRecursive() function for handling file and directory copying.
- Anti-Patterns: Highlights common pitfalls to avoid, such as adding npm dependencies and overwriting user state.
Quick Start
To start using the Squad conventions, review the provided documentation and incorporate the patterns into your Squad CLI tool development.