The best way to control Claude Code, Codex and more from any computer or phone

main
md 41 lines 4.29 KB
Rendered Raw
1 # Package Registration
2
3 Use current configuration and the closest package in the same family as the
4 sources of truth. A package-local build does not prove repository registration.
5 Classify every row as applicable or not applicable.
6
7 ## Workspace And TypeScript
8
9 | Surface | Check |
10 | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11 | `pnpm-workspace.yaml` | Its globs cover the package path and exact-name pnpm selection discovers it. |
12 | `pnpm-lock.yaml` | The current importer, name, and dependencies exist; renamed or moved importers are gone. |
13 | `tsconfig.packages.json` | Packages intended to participate in the root TypeScript project-reference graph are referenced. Follow neighboring package policy; buildable private tools are not automatically included. |
14 | `tsconfig.tests.json` | Broad test globs cover the path. Add source aliases only when tests require workspace source routing or would otherwise create a dependency cycle. Preserve intentional platform exclusions. |
15
16 ## Tests And Documentation
17
18 | Surface | Check |
19 | -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
20 | `vitest.config.ts` | A package with runtime tests has the intended project, environment, setup, and inclusion rules. |
21 | `tstyche.json` | Type-test discovery covers the package depth; current globs cover one- and two-level package layouts. |
22 | `vitest.docs.ts` | Doctest source discovery covers packages with runnable JSDoc examples; current globs cover one- and two-level package layouts. |
23 | `jsdocs.config.json` | Public source is included in JSDoc checks and exclusions by package family remain intentional. |
24 | `deno.json` | Deno checks cover the package family, or its exclusion is intentional. |
25
26 ## Release And Discovery
27
28 | Surface | Check |
29 | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
30 | `.changeset/config.json` | Published fixed-group membership uses the current name; private tooling is not added solely because it builds. |
31 | `README.md` | Public catalog entries have the current name, path, description, and documentation link. |
32 | AI documentation copy tooling and package `files` | Published payloads include required generated documentation. Continue with [publishing.md](publishing.md) for the full packed-surface audit. |
33 | Snapshot publishing workflows | Snapshot publishing selects the package path. Existing globs may already cover it; apply root workflow requirements before editing. |
34 | Runtime-specific CI workflows | Runtime-specific packages participate in applicable runtime jobs; apply root workflow requirements before editing. |
35
36 ## Paths And Consumers
37
38 Audit explicit workspace package names in root tooling manifests. Search scripts
39 for the package family, old name, and old path to find path-sensitive clean,
40 codemod, circularity, copy, and related behavior. Explain every remaining old
41 reference after a rename or move.