squad-conventions

Document and enforce Squad conventions for JavaScript/Node.js codebases.

413|64|Updated Feb 7, 2023
One-click install
npx skills add https://github.com/christianhelle/refitter --skill squad-conventions-christianhelle
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: squad-conventions
Source: https://github.com/christianhelle/refitter/tree/main/.copilot/skills/squad-conventions
Command: npx skills add https://github.com/christianhelle/refitter --skill squad-conventions-christianhelle

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

These conventions provide a single source of truth for Squad codebase patterns, improving consistency, on-boarding, and maintainability across projects.

Core Features & Use Cases

  • Zero-Dependency: Squad uses Node.js built-in modules, avoiding external runtime dependencies.
  • Structured patterns: Standardized file structure, error handling with fatal() pattern, and color constants, ensuring consistent UX and error reporting.
  • Init and upgrade hygiene: Idempotent init patterns and safe upgrade practices for Squad-owned files.
  • Windows compatibility: Path handling with cross-platform approaches using path.join() to support all OSes.
  • Copy and template guidelines: Safe, recursive copy patterns for templates and assets.

Quick Start

Follow these conventions in your Squad project to standardize structure, testing, and error handling.

Frequently Asked Questions about squad-conventions

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

FAQPage Schema
What are standard Node.js code conventions for zero-dependency project structure?▼

Standard Node.js conventions for zero-dependency projects enforce using built-in modules, structured file organization, the fatal() error handling pattern, and cross-platform path handling with path.join() for consistent code quality.

How do I handle cross-platform file paths in Node.js to support Windows compatibility?▼

Handle cross-platform file paths in Node.js by using path.join() to construct paths, ensuring Windows compatibility and consistent behavior across all operating systems within your codebase.

How do I implement idempotent init and safe upgrade practices for JavaScript tooling?▼

Implement idempotent init and safe upgrade practices by applying structured patterns that safely manage Squad-owned files during initialization and upgrades, preventing duplicate or destructive file operations.

What is the fatal pattern for error handling in Node.js codebases?▼

The fatal pattern for error handling in Node.js codebases is a standardized approach that ensures consistent UX and error reporting by immediately terminating execution when critical errors occur.

Can I use external runtime dependencies in Squad codebases?▼

No, Squad codebases follow zero-dependency patterns by using Node.js built-in modules only, avoiding external runtime dependencies to improve maintainability and reduce complexity.

What's the best way to ensure consistent code quality across contributor teams?▼

The best way to ensure consistent code quality across contributor teams is to document standard conventions including file structure, error handling patterns, testing guidelines, and project structure as a single source of truth.