squad-conventions

Document core conventions for the Squad CLI tool with Node.js built-in testing and fatal() error handling.

6|8|Updated Apr 22, 2023
One-click install
npx skills add https://github.com/Ansteorra/KMP --skill squad-conventions-ansteorra
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: squad-conventions
Source: https://github.com/Ansteorra/KMP/tree/main/.ai-team-templates
Command: npx skills add https://github.com/Ansteorra/KMP --skill squad-conventions-ansteorra

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill defines the core conventions and patterns used within the Squad codebase, ensuring consistency and maintainability for developers contributing to the project.

Core Features & Use Cases

  • Zero Dependencies: Enforces the use of only Node.js built-ins, preventing external package bloat.
  • Standardized Testing: Utilizes the built-in Node.js test runner for all tests.
  • Consistent Error Handling: Mandates the use of a fatal() function for user-facing errors.
  • Use Case: A new developer joins the Squad project and needs to understand how to structure their code, handle errors, and write tests according to the established project guidelines.

Quick Start

Understand the core conventions for contributing to the Squad CLI tool.

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 without adding external dependencies?

Use a standardized `fatal()` function to handle user-facing errors in your Node.js CLI. This convention ensures consistent error reporting while maintaining a zero-dependency codebase by relying strictly on Node.js built-ins.

How do I write tests for a Node.js CLI using only built-in modules?

Write tests for your Node.js CLI using the built-in Node.js test runner. This convention enforces zero external dependencies by standardizing on the native test runner for all testing requirements within the project.

What are the best code standards for maintaining a zero-dependency Node.js CLI?

The best code standards for a zero-dependency Node.js CLI include enforcing native built-ins, standardizing error handling with `fatal()`, ensuring Windows compatibility, and maintaining initialization idempotency for AI agent team integrations.

Does the Squad CLI conventions Skill require any external packages to set up?

No, the Squad CLI conventions strictly enforce a zero-dependency policy. You must use only Node.js built-ins for implementation and testing, preventing any external package bloat during setup or development.

How do I structure files and ensure initialization idempotency for an AI agent team CLI?

Structure files according to the documented conventions and maintain initialization idempotency to ensure safe, repeated executions. This approach guarantees maintainable AI agent team integrations within the Node.js CLI environment.

Why does my Node.js CLI need to maintain Windows compatibility for AI agent integrations?

Your Node.js CLI needs Windows compatibility to ensure cross-platform execution and maintainable AI agent team integrations. The conventions mandate this compatibility alongside initialization idempotency for consistent behavior.