squad-conventions

Document core development conventions for the Squad CLI project.

1|Updated Oct 1, 2025
One-click install
npx skills add https://github.com/diberry/microsoft-mcp-doc-generation --skill squad-conventions-diberry
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: squad-conventions
Source: https://github.com/diberry/microsoft-mcp-doc-generation/tree/main/.squad-templates
Command: npx skills add https://github.com/diberry/microsoft-mcp-doc-generation --skill squad-conventions-diberry

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides essential guidelines and patterns for developing within the Squad codebase, ensuring consistency and maintainability across the project.

Core Features & Use Cases

  • Zero Dependencies: Enforces the use of Node.js built-ins only, preventing external package bloat.
  • Standardized Error Handling: Implements a consistent fatal() pattern for user-facing errors.
  • Cross-Platform Compatibility: Ensures code works seamlessly on Windows, macOS, and Linux.
  • Use Case: When contributing to the Squad CLI, follow these conventions to ensure your code integrates smoothly with the existing project, adheres to best practices, and passes all automated checks.

Quick Start

Follow the zero-dependency rule when adding new functionality to the Squad CLI.

Frequently Asked Questions about squad-conventions

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

FAQPage Schema
How do I handle fatal errors in a Node.js CLI project without adding external dependencies?

To handle fatal errors without external dependencies, implement a standardized `fatal()` pattern for all user-facing errors. This convention ensures consistent error reporting across the Squad CLI while maintaining a zero runtime dependency rule by using Node.js built-ins only.

What are the best practices for structuring a cross-platform Node.js CLI tool?

Best practices for structuring a cross-platform Node.js CLI tool include enforcing zero runtime dependencies, using the Node.js built-in test runner, and ensuring Windows compatibility. Adhering to specific file structures and idempotent initialization ensures project consistency and maintainability.

Do I need external testing frameworks for Node.js CLI development?

No, you do not need external testing frameworks for Node.js CLI development. The Squad CLI conventions enforce using the Node.js built-in test runner exclusively, eliminating the need for external dependencies and preventing package bloat while maintaining standardized testing.

How do I standardize CLI output formatting using only Node.js built-ins?

To standardize CLI output formatting using only Node.js built-ins, apply specific ANSI color constants defined in the project conventions. This approach enforces the zero-dependency rule while providing consistent terminal styling across Windows, macOS, and Linux environments.

Why does my Node.js CLI initialization fail on subsequent runs?

Node.js CLI initialization fails on subsequent runs if the process is not idempotent. Following Squad CLI conventions, initialization must be designed to be idempotent, ensuring repeated executions produce consistent results without causing errors or duplicating file structures.