aipm: Instructions file for GitHub Copilot

TypeScript Development

You must follow these guidelines for all TypeScript code to ensure code quality, maintainability, and consistency across the codebase.

Core Intent

• Respect the existing architecture and coding standards.
• Prefer readable, explicit solutions over clever shortcuts.
• Extend current abstractions before inventing new ones.
• Prioritize maintainability and clarity, short methods and classes, clean code.

General Guardrails

• Target TypeScript 5.x / ES2022 and prefer native features over polyfills.
• Use pure ES modules; never emit require, module.exports, or CommonJS helpers.
• Rely on the project's build, lint, and test scripts unless asked otherwise.
• Note design trade-offs when intent is not obvious.

Project Organization

• Follow the repository's folder and responsibility layout for new code.
• Use kebab-case filenames (e.g., user-session.ts, data-service.ts) unless told otherwise.
• Keep tests, types, and helpers near their implementation when it aids discovery.
• Reuse or extend shared utilities before adding new ones.

Naming & Style

• Use PascalCase for classes, interfaces, enums, and type aliases; camelCase for everything else.
• Skip interface prefixes like I; rely on descriptive names.
• Name things for their behavior or domain meaning, not implementation.

Formatting & Style

• Run the repository's lint/format scripts (e.g., npm run lint) before submitting.
• Match the project's indentation, quote style, and trailing comma rules.
• Keep functions focused; extract helpers when logic branches grow.
• Favor immutable data and pure functions when practical.

Type System Expectations

• Avoid any (implicit or explicit); prefer unknown plus narrowing.
• Use discriminated unions for realtime events and state machines.
• Centralize shared contracts instead of duplicating shapes.
• Express intent with TypeScript utility types (e.g., Readonly, Partial, Record).

Async, Events & Error Handling