i18nprune documentation
These pages are written for a Nextra site: each topic lives in its own folder with a README.md.
Links
| Resource | URL |
|---|---|
| Docs site | docs.i18nprune.dev |
| Repository | github.com/zamdevio/i18nprune |
| npm package | npmjs.com/package/@zamdevio/i18nprune |
Index
One topic → one home: Canonical topic map.
| Topic | Description |
|---|---|
| Exports | @zamdevio/i18nprune/config & /core — programmatic API |
| Examples | Advanced CLI workflows (CI, --report-file, batch sync/fill, cleanup) |
| Dynamic keys | Reduce dynamic usage; configure functions; how the tool classifies sites |
| Contributing | Repo patterns; links to Agents for AI-assisted contributors |
| Commands | One page per CLI subcommand (incl. missing) |
| CLI overview | Entry point, global flags, preprocessArgv |
JSON output (--json) | Machine-readable CLI stdout: envelope, flags, data payloads |
| Issue codes | Stable issues[] codes for --json and library |
| Pre-release doc checklist | Refresh tree / exports / links before shipping a phase |
| Edge cases | Solved pitfalls (per-file const maps, CLI --json parity) |
| Quiet, silent & JSON | RunOptions, logger, output policy |
| CLI runtime | getRunOptions / setRunOptions vs full Context |
| Architecture | Layers and data flow |
| Languages catalog | languages.json, generator |
| Project tree | Source / tooling layout (excludes dist, docs site) |
| ADRs | Architecture decision records |
| ADR template | Skeleton for new ADRs |
| ADR 003 — User i18n loader | Opt-in loader integration (proposed) |
| ADR 005 — Dynamic key rebuild & prefix | Const map, template rebuild, resolvedPrefix |
| Loader & config | User-project i18n module (future) |
| Prompts & CLI boundaries | Inquirer scope, --json / CI, utils debt |
| Command orchestration | Command vs core file layout |
| Programmatic API & JSON | Library Result roadmap vs CLI --json |
| Translator engine | Provider, translateLeaf, generate / fill flows |
| Vision | Product direction |
| npm scope & org (future) | Reserved @i18nprune org; possible migration from @zamdevio — planning only |
| Roadmap | High-level direction |
| Workflow | Local dev commands |
| Agents | Onboarding for contributors & coding agents — analysis (full map), git (commit discipline) |
| Barriers | Adoption friction |
| Config | Config file formats, merge order, defineConfig |
| Policies | policies.preserve / policies.parity |
| Exit codes & signals | Exit codes, SIGINT, interactive vs CI |
| Command behaviors | Snapshot table: flags, JSON, translator commands |
| Phases (maintainers) | Phase index, completed sprint records (docs/phases/**) — included in the docs tree when you run pnpm run docs:sync |
| Translation progress | Live bar policy (-q / -s / --json), packages/cli/src/core/progress/* |
| Patching | Opt-in loader + config auto-patches (ADR 004) |
| Origin | Why the project exists — real constraints, not a toy; link to CepatEdge context |
| Cursor | How the repo was built — agent acceleration, usage limits, human direction |
| Launch & adoption | Pre-launch checklist & positioning; distribution scheduling for posts/changelog timing |
Nextra
Edit docs/ only; run pnpm docs:sync from the repo root to refresh apps/docs/content/.