Skip to content

CLAUDE.md

Latest commit

 

History

History
53 lines (35 loc) · 1.66 KB

CLAUDE.md

File metadata and controls

53 lines (35 loc) · 1.66 KB
Raw

aimock

Before Every Commit

Run these checks on all changed files before committing:

pnpm run format:check    # prettier
pnpm run lint            # eslint
pnpm run test            # vitest

If prettier or eslint fail, fix with:

npx prettier --write <files>
npx eslint --fix <files>

A pre-commit hook (husky + lint-staged) runs prettier and eslint automatically on staged files, but always verify manually before pushing — CI checks the entire repo, not just staged files.

Project Structure

  • src/ — TypeScript source (server, router, helpers, responses, types)
  • src/__tests__/ — Vitest test suite
  • docs/ — GitHub Pages website (static HTML)
  • fixtures/ — Example fixture JSON files shipped with the package

Testing

  • Tests live in src/__tests__/ and use Vitest
  • When adding features or fixing bugs, add or update tests
  • Run pnpm test before pushing

Drift Remediation

Automated drift remediation lives in scripts/:

  • scripts/drift-report-collector.ts — runs drift tests, produces drift-report.json
  • scripts/fix-drift.ts — reads drift report, invokes Claude Code to fix builders, creates PR or issue

See DRIFT.md for full documentation and .github/workflows/fix-drift.yml for the CI workflow.

Forbidden Paths

  • NEVER commit internal planning documents (specs, plans, design docs) to this repo. No docs/superpowers/, no docs/plans/, no docs/specs/. These are gitignored. Store them in Notion or ~/.claude/ instead.

Commit Messages

  • This repo enforces conventional commit prefixes via commitlint: fix:, feat:, docs:, test:, chore:, refactor:, etc.
  • No Co-Authored-By lines