busirocket-typescript-standards_skill

Overview

This skill defines strict TypeScript and React standards to keep codebases maintainable, predictable, and easy to review. It enforces one-export-per-file, strict type placement, naming conventions, and Next.js special-file exceptions. Use it as a checklist and automated rule set when creating or refactoring .ts/.tsx sources.

How this skill works

The skill inspects source layout and type usage rules, flags inline types, multiple exported symbols, and helper placement that violate conventions. It documents targeted rule files for each policy (one-thing-per-file, type placement, Next.js exceptions) and recommends running project checks after changes. Rules include explicit exceptions for Next.js special files and guidance for shared types under a types/ directory.

When to use it

• Writing new .ts or .tsx files to ensure consistent structure and naming
• Refactoring components, hooks, services, or route handlers to move types out
• Adding shared shapes that should live under types/<area>/ with one type per file
• Working on a Next.js app where special files need controlled extra exports
• Before pull requests to validate exports, type placement, and project checks

Best practices

• Export exactly one symbol per module you author to reduce coupling and improve discoverability
• Place shared interfaces and types in types/<area>/ and keep one type per file
• Avoid barrel index.ts files that hide module boundaries and make dependencies implicit
• Do not declare inline interface/type in components, hooks, utils, services, or route handlers
• After meaningful changes, run the project's verification command (e.g. yarn check:all)

Example use cases

• Refactor a component that currently defines prop types inline into a types/Props file
• Audit a codebase to remove index.ts barrels and make module boundaries explicit
• Implement API route handlers in Next.js while allowing required method exports in app/api/**/route.ts
• Create a shared Result type for service boundaries and keep it in its own file with a Result suffix
• Enforce naming patterns like Params, Result, Error, and Props across a feature area