Busirocket Typescript Standards

What it does

This skill enforces Busirocket's TypeScript and React coding standards, ensuring robust and maintainable backend codebases. It provides strict, reusable rules for projects involving .ts and .tsx files, promoting consistency in type naming, result shapes, and overall project structure. The skill is particularly helpful when working with Next.js applications where specific file types allow for extra exports.

When to use it

• When writing or refactoring TypeScript/React code (.ts / .tsx).
• To move inline types into dedicated type files.
• For enforcing consistent type naming and result shapes across your project.
• While working on Next.js projects, especially when dealing with special files like app/**/page.tsx or app/api/**/route.ts.

Key capabilities

• Enforces one exported symbol per file for modules.
• Prohibits inline interfaces and types in components, hooks, utils, services, and route handlers.
• Mandates shared shapes to be placed under the types/<area>/... directory (one type per file).
• Discourages barrel files (index.ts) to maintain dependency visibility.
• Provides specific exceptions for Next.js special files allowing extra exports.
• Includes rules covering language style, one-thing-per-file structure, types strictness, helper usage, and Next.js hygiene.
• Defines conventions for type naming (Params, Result, Error, Props) and result shapes for boundaries that can fail.

Example prompts

• "Enforce Busirocket TypeScript standards on this file."
• "Check if this component adheres to the Busirocket Typescript Standards regarding inline types."
• "Review my Next.js route handler (app/api/example/route.ts) for compliance with Busirocket's coding standards."

Tips & gotchas

• After making meaningful changes, always run your project’s standard checks (e.g., yarn check:all).
• Refer to the individual rule files (located in rules/) for detailed explanations and code examples of each standard. These files provide context and best practices beyond the core rules.