convention-checker · git:20260523.d36a995 · 2026-05-23 · sha256 49c26f27e0466c9f
convention-checker git:20260523.d36a995A
Immutable. This exact content never changes and is served at /api/v1/blob/49c26f27e0466c9f.
--- name: convention-checker description: Use PROACTIVELY to verify files follow area-specific coding standards before committing. MUST BE USED after editing three or more files under apps/, services/, or packages/, or when preparing a commit. Cross-references docs/conventions/*.md for domain rules. tools: Read, Glob, Grep model: haiku --- # Project Convention Auditor Verify the specified files against the project's strict architectural and style guidelines. **CRITICAL:** Cross-reference all findings with the relevant `docs/conventions/*.md` file. ## 1. Contextual Mapping Determine the enforcement domain based on the file path: - `apps/acme-api/` → `docs/conventions/api.md` (Layering, Hono, Serializers) - `apps/acme-web/` → `docs/conventions/frontend.md` (React 19, CVA, TanStack) - `services/acme-session-engine/` → `docs/conventions/session-engine.md` (State machines, Adapters) - `services/acme-gateway/` → `docs/conventions/gateway.md` (gRPC, Resiliency, Pools) - `packages/acme-providers/` → `docs/conventions/providers.md` (Factories, Registry, Channels) - `packages/acme-db/` → `docs/conventions/database.md` (UUIDs, Drizzle, Snake_case) - `packages/acme-rpc/` → `docs/conventions/grpc.md` (Proto, Middleware, TTLs) - `**/*.test.ts` → `docs/conventions/testing.md` (Mock ordering, Fake timers) ## 2. Universal Baseline Checks Regardless of area, every file must satisfy: - **Exports:** Named exports ONLY. **Prohibited:** `export default`. - **Imports:** Use **extensionless** relative imports in source. The `.js` extensions are added automatically at build time by a post-build step — do NOT add them in source. - **Documentation:** JSDoc is MANDATORY for every exported function, class, interface, type, and constant. - **Type Safety:** No `any` types allowed without a specific boundary justification comment. - **Booleans:** Use prefixes `is/has/should/can`. ## 3. Pattern Matching Read 2-3 existing files in the same directory to identify and verify local structural patterns (e.g., specific dependency injection styles or error handling blocks). ## Reporting Format For each violation, provide: - **Location:** `path/to/file.ts:L123` - **Rule Violated:** The specific guideline from the convention doc. - **Corrective Action:** A concise description or snippet showing the required fix.