skills.rest
mpaulosky
mpauloskyCOMMUNITY
Explore all skills by this author →
GitHub

squad-conventions

Document core conventions for the Squad CLI tool using Node.js built-ins.

Updated Oct 25, 2024
Search Tags:#testing#error handling#patterns#conventions#nodejs#squad
One-click install
npx skills add https://github.com/mpaulosky/IssueTracker --skill squad-conventions-mpaulosky
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: squad-conventions
Source: https://github.com/mpaulosky/IssueTracker/tree/main/.ai-team-templates
Command: npx skills add https://github.com/mpaulosky/IssueTracker --skill squad-conventions-mpaulosky

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides essential knowledge of the core conventions and patterns used within the Squad codebase, ensuring consistency and maintainability for all contributors.

Core Features & Use Cases

  • Zero Dependencies: Understand the strict requirement to use only Node.js built-ins.
  • Testing Standards: Learn to use the Node.js built-in test runner for all tests.
  • Error Handling: Implement robust error handling using the fatal() pattern.
  • Use Case: Before contributing to the Squad CLI tool, a developer can study this Skill to ensure their code adheres to all established patterns, preventing common mistakes and maintaining project integrity.

Quick Start

Review the squad-conventions skill to understand the project's zero-dependency rule.

Frequently Asked Questions about squad-conventions

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

FAQPage Schema
How do I handle errors in a Node.js CLI tool without external dependencies?▼

Use the fatal() pattern for error handling in Node.js CLI tools to maintain zero runtime dependencies, ensuring robust error management by relying solely on built-in modules.

What testing framework should I use for Node.js built-in only projects?▼

Use the Node.js built-in test runner for testing projects with zero dependencies, ensuring all tests adhere to strict conventions without requiring external testing frameworks.

How do I ensure Windows compatibility when building Node.js command line interfaces?▼

Ensure Windows compatibility in Node.js command line interfaces by following established file structure patterns and idempotent initialization, preventing common cross-platform issues.

Do I need any npm packages to implement ANSI color constants in a CLI?▼

No npm packages are needed to implement ANSI color constants in a CLI; the zero dependency convention requires using only Node.js built-ins for terminal color output.

What does idempotent initialization mean for Node.js file structures?▼

Idempotent initialization in Node.js file structures means setup operations can run repeatedly without causing side effects, ensuring stable and predictable project configurations.

Why enforce a zero runtime dependency rule in Node.js applications?▼

Enforcing a zero runtime dependency rule in Node.js applications ensures maintainability and consistency, requiring developers to use only Node.js built-ins for all source code modifications.

Related Skills

Explore More Software Engineering Skills→
csharpfritzcsharpfritz
18

squad-conventions

Enforce Squad CLI development conventions with zero dependencies and Node.js built-in tests.

Community
Intermediate
bradygasterbradygaster
3.1k

squad-conventions

Define development conventions for the Squad CLI using Node.js built-in modules.

Community
Basic
usepowershellusepowershell
9

squad-conventions

Enforce Squad CLI conventions for zero-dependency, safe file operations, and error handling.

Community
Intermediate
wesleyegbertowesleyegberto
3

cli-developer

Generate cross-platform CLI templates and patterns for Node.js, Python, and Go.

Community
Advanced