Benjamin DiedrichsenandClaude Opus 5
7862fab809
Phase 9 of packages/keyman/docs/PLAN.md; closes AUDIT §5.2, §5.3, §5.4, §5.5, and the §4 one-liners no phase had claimed (§4.1–§4.4, §3.7). The README is the only document that ships (package.json files: dist, README.md, LICENSE), and it described four of nine menu entries, invented key rotation, told the user to run ssh-keygen by hand, asked them to write a .gitignore keyman now writes, and mentioned none of the command line. It is rewritten against the code: every operation, the rotate/retire sequence, the id_ prefix and what happens to keys without it, installation with the scope mapping (never a bare --registry, which would send 55 transitive dependencies to a registry that has never heard of them), the configuration semantics including which relative path resolves against what, and the Phase 5 migration for a split vault. The CLI section is helpText() verbatim, with tests/readme.test.ts asserting the two are identical and that every menu label appears — so a flag or an operation added later fails the gate instead of shipping undocumented. That is the part that keeps this from drifting again. Also: index.ts loses the bin's shebang (it is only ever imported), exports the config types so a consumer can name what loadConfig returns, and re-exports the update module wholesale rather than half of it by name — verified by importing the built dist/index.js and reading its keys. The narrow surface is now a comment stating the rule rather than an accident. AUDIT.md marks all 30 findings closed except the second half of §1.8, keeping each finding's text as the record with what closed it quoted underneath, the way DOCS-AUDIT.md does. PLAN.md gains a status section naming the three deviations. Root CLAUDE.md records the keyman architecture as it now is, including the deliberate `resolution` divergence from nopy. DOCS-AUDIT.md §2.10, §6.4 and the §7 keyman-config entry are amended in the working tree but left unstaged, since that file carries unrelated WIP. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
16 lines
823 B
TypeScript
16 lines
823 B
TypeScript
/**
|
|
* The library surface — `exports["."]`, imported and never executed, which is why
|
|
* it no longer carries the bin's shebang (AUDIT §4.1). The bin is
|
|
* `dist/keyman.cli.js`.
|
|
*
|
|
* Deliberately narrow: config resolution, the update machinery, and `keyman()` to
|
|
* run the menu. The operation modules stay internal — every one of them prompts,
|
|
* prints and spawns, so there is nothing to do with a single one except reproduce
|
|
* the menu around it (§4.3). The update module is re-exported wholesale rather
|
|
* than by name list, because the list had drifted to half of it (§4.4).
|
|
*/
|
|
export type { KeymanConfig, KeymanConfigFile } from './keyman.config.js';
|
|
export { describeConfig, loadConfig, resolveConfigPaths } from './keyman.config.js';
|
|
export * from './keyman.main.js';
|
|
export * from './keyman.update.js';
|