swpm-dev-standards

Codify SWPM development standards for typing, naming, and file structure.

125|5|Updated May 13, 2022
One-click install
npx skills add https://github.com/deinsoftware/swpm --skill swpm-dev-standards
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swpm-dev-standards
Source: https://github.com/deinsoftware/swpm/tree/main/.agents/skills/swpm-dev-standards
Command: npx skills add https://github.com/deinsoftware/swpm --skill swpm-dev-standards

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a centralized set of rules and patterns to ensure consistent SWPM development practices across the codebase, including typing, file structure, naming, and common coding patterns.

Core Features & Use Cases

  • Typing rules: use type rather than interface, avoid any, import type for type-only imports, and keep types in *.types.ts files.
  • File structure and naming: guidance on folder layout and kebab-case file naming conventions.
  • Allowed patterns and clean code: rules for ternaries without business logic, early returns, named exports for utilities, and preferred try/catch styles.
  • Export patterns and reviews: guidance on default exports for configs/commands and named exports for utilities; best practices for code reviews and onboarding.
  • SOLID and Clean Code: principles emphasis and architecture guidance.

Quick Start

Ask this skill for the SWPM development standards before starting a new module.

Frequently Asked Questions about swpm-dev-standards

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

FAQPage Schema
What are the SWPM development standards for TypeScript typing and file structure?

SWPM development standards mandate using type over interface, avoiding any, keeping types in *.types.ts files, and enforcing kebab-case file naming conventions to ensure consistent codebase structure.

How do I enforce coding conventions during code reviews and onboarding?

Enforce coding conventions by applying centralized rules during file creation and code reviews, checking for explicit exports, early returns, preferred try/catch styles, and arrow function patterns to guide onboarding.

When should I use named exports versus default exports in a TypeScript project?

Use default exports for configurations and commands, while reserving named exports for utility functions. This pattern ensures clear module boundaries and consistent import behaviors across the project architecture.

Does this coding standards skill require any specific dependencies or ESLint plugins?

No dependencies are required to apply these coding standards. The rules are codified directly within the skill to enforce SOLID principles, typing rules, and clean code patterns without needing external ESLint plugins.

What is the best way to structure a new module following SWPM code conventions?

The best way to structure a new module is to follow the defined folder layout, use kebab-case for file names, separate types into *.types.ts files, and ensure business logic is kept out of ternary operators.