squad-conventions

Apply zero-dependency conventions to Squad CLI code, tests, and project structure.

7|Updated Oct 24, 2020
One-click install
npx skills add https://github.com/snow-jallen/HomeSpeaker --skill squad-conventions-snow-jallen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: squad-conventions
Source: https://github.com/snow-jallen/HomeSpeaker/tree/main/.copilot/skills/squad-conventions
Command: npx skills add https://github.com/snow-jallen/HomeSpeaker --skill squad-conventions-snow-jallen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

These conventions provide a centralized, zero-dependency pattern set to ensure consistency, reliability, and efficient onboarding across Squad CLI tooling.

Core Features & Use Cases

  • Zero Dependencies: Squad uses Node.js built-ins only; no external runtime dependencies.
  • Windows Compatibility: All paths use path.join() to ensure cross-platform operation.
  • Robust Init & Upgrade: Init skips existing user state; upgrades overwrite only Squad-owned files.
  • Structured File Layout: Prescribed .squad/ directories and templates/ for maintainability.
  • Error Handling & UX: Use a consistent fatal(msg) approach and color constants for user-facing messages.

Quick Start

Follow these conventions when modifying or building Squad CLI tooling to ensure consistency and cross-platform reliability.

Frequently Asked Questions about squad-conventions

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

FAQPage Schema
How do I enforce zero-dependency coding standards in a Node.js CLI project?

To enforce zero-dependency coding standards in a Node.js CLI, use only Node.js built-in modules without external runtime dependencies. This approach ensures consistency, reduces errors, and streamlines onboarding across Squad CLI tooling.

What is the best way to ensure Node.js CLI compatibility across Windows, macOS, and Linux?

The best way to ensure Node.js CLI compatibility across Windows, macOS, and Linux is to use path.join() for all file paths. This cross-platform convention prevents OS-specific path errors and ensures reliable operation.

How do I structure files and handle errors in a Squad CLI project?

To structure files and handle errors in a Squad CLI project, organize code into prescribed `.squad/` directories and `templates/`, and use a consistent fatal(msg) approach for safe error handling. This reduces cognitive load and improves maintainability.

Does the Squad CLI init command overwrite existing user configuration files?

No, the Squad CLI init command does not overwrite existing user state; it safely skips current configurations. During upgrades, the tool only overwrites Squad-owned files to prevent data loss.

Why do my Node.js CLI scripts fail with path errors on Windows?

Node.js CLI scripts fail with path errors on Windows when using hardcoded slashes instead of path.join(). Standardizing file paths with path.join() ensures cross-platform operation across Windows, macOS, and Linux.