Eve library

Type Declaration Artifact Policy

Runbook

Revision 1

On this page

The repository generates a large number of .d.ts files during local builds (especially under services/lib/). To keep the tree clean and reviewable:

  • Treat .d.ts and .d.ts.map files as build artifacts. They are ignored globally in .gitignore, with a short allowlist for hand-authored entrypoints that must stay versioned (see the exception list in .gitignore).
  • Do not commit newly generated declaration files. If you notice untracked .d.ts output locally, run the relevant clean script (e.g., npm run clean in the service) or remove the files after use.
  • To regenerate declarations, use the service’s normal build (npm run build) or tsc --declaration where applicable. This keeps TypeScript consumers whole without bloating git history.
  • When adding a truly hand-written declaration file that should be tracked, explicitly add an exception to .gitignore and document why it is needed in the owning package’s README.

This policy reduces noise from 10k+ generated artifacts while keeping intentional API surfaces documented.