ai-i18n-tools 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/README.md +12 -8
  2. package/data/ui-languages-complete.json +480 -0
  3. package/dist/build-info.generated.d.ts +3 -0
  4. package/dist/build-info.generated.d.ts.map +1 -0
  5. package/dist/build-info.generated.js +3 -0
  6. package/dist/build-info.generated.js.map +1 -0
  7. package/dist/cli/doc-translate.d.ts +27 -3
  8. package/dist/cli/doc-translate.d.ts.map +1 -1
  9. package/dist/cli/doc-translate.js +346 -109
  10. package/dist/cli/doc-translate.js.map +1 -1
  11. package/dist/cli/extract-strings.d.ts +2 -0
  12. package/dist/cli/extract-strings.d.ts.map +1 -1
  13. package/dist/cli/extract-strings.js +45 -2
  14. package/dist/cli/extract-strings.js.map +1 -1
  15. package/dist/cli/format.d.ts +6 -0
  16. package/dist/cli/format.d.ts.map +1 -1
  17. package/dist/cli/format.js +15 -0
  18. package/dist/cli/format.js.map +1 -1
  19. package/dist/cli/generate-ui-languages.d.ts +21 -0
  20. package/dist/cli/generate-ui-languages.d.ts.map +1 -0
  21. package/dist/cli/generate-ui-languages.js +35 -0
  22. package/dist/cli/generate-ui-languages.js.map +1 -0
  23. package/dist/cli/index.js +190 -39
  24. package/dist/cli/index.js.map +1 -1
  25. package/dist/cli/translate-svg.d.ts.map +1 -1
  26. package/dist/cli/translate-svg.js +17 -2
  27. package/dist/cli/translate-svg.js.map +1 -1
  28. package/dist/cli/translate-ui-strings.js +2 -2
  29. package/dist/core/config.d.ts +6 -0
  30. package/dist/core/config.d.ts.map +1 -1
  31. package/dist/core/config.js +58 -15
  32. package/dist/core/config.js.map +1 -1
  33. package/dist/core/locale-utils.d.ts +5 -0
  34. package/dist/core/locale-utils.d.ts.map +1 -1
  35. package/dist/core/locale-utils.js +7 -0
  36. package/dist/core/locale-utils.js.map +1 -1
  37. package/dist/core/prompt-builder.d.ts +2 -2
  38. package/dist/core/prompt-builder.d.ts.map +1 -1
  39. package/dist/core/prompt-builder.js +4 -6
  40. package/dist/core/prompt-builder.js.map +1 -1
  41. package/dist/core/prompts.d.ts +2 -1
  42. package/dist/core/prompts.d.ts.map +1 -1
  43. package/dist/core/prompts.js +2 -2
  44. package/dist/core/prompts.js.map +1 -1
  45. package/dist/core/types.d.ts +4 -1
  46. package/dist/core/types.d.ts.map +1 -1
  47. package/dist/core/types.js +10 -8
  48. package/dist/core/types.js.map +1 -1
  49. package/dist/core/ui-languages-catalog.d.ts +26 -0
  50. package/dist/core/ui-languages-catalog.d.ts.map +1 -0
  51. package/dist/core/ui-languages-catalog.js +78 -0
  52. package/dist/core/ui-languages-catalog.js.map +1 -0
  53. package/dist/core/ui-languages.d.ts +14 -17
  54. package/dist/core/ui-languages.d.ts.map +1 -1
  55. package/dist/core/ui-languages.js +36 -96
  56. package/dist/core/ui-languages.js.map +1 -1
  57. package/dist/index.d.ts +3 -2
  58. package/dist/index.d.ts.map +1 -1
  59. package/dist/index.js +3 -2
  60. package/dist/index.js.map +1 -1
  61. package/dist/processors/emphasis-placeholders.d.ts +26 -0
  62. package/dist/processors/emphasis-placeholders.d.ts.map +1 -1
  63. package/dist/processors/emphasis-placeholders.js +231 -21
  64. package/dist/processors/emphasis-placeholders.js.map +1 -1
  65. package/dist/processors/html-tag-placeholders.d.ts +7 -0
  66. package/dist/processors/html-tag-placeholders.d.ts.map +1 -0
  67. package/dist/processors/html-tag-placeholders.js +135 -0
  68. package/dist/processors/html-tag-placeholders.js.map +1 -0
  69. package/dist/processors/placeholder-handler.d.ts +10 -2
  70. package/dist/processors/placeholder-handler.d.ts.map +1 -1
  71. package/dist/processors/placeholder-handler.js +16 -7
  72. package/dist/processors/placeholder-handler.js.map +1 -1
  73. package/dist/processors/translation-placeholder-leaks.js +1 -1
  74. package/dist/processors/translation-placeholder-leaks.js.map +1 -1
  75. package/dist/runtime/i18next-helpers.d.ts +4 -2
  76. package/dist/runtime/i18next-helpers.d.ts.map +1 -1
  77. package/dist/runtime/i18next-helpers.js +9 -2
  78. package/dist/runtime/i18next-helpers.js.map +1 -1
  79. package/dist/runtime/ui-languages-master-direction.d.ts +5 -0
  80. package/dist/runtime/ui-languages-master-direction.d.ts.map +1 -0
  81. package/dist/runtime/ui-languages-master-direction.js +24 -0
  82. package/dist/runtime/ui-languages-master-direction.js.map +1 -0
  83. package/docs/GETTING_STARTED.md +86 -35
  84. package/docs/PACKAGE_OVERVIEW.md +6 -4
  85. package/docs/ai-i18n-tools-context.md +49 -440
  86. package/package.json +26 -22
  87. package/translated-docs/README.de.md +13 -9
  88. package/translated-docs/README.es.md +13 -9
  89. package/translated-docs/README.fr.md +13 -9
  90. package/translated-docs/README.hi.md +13 -9
  91. package/translated-docs/README.ja.md +13 -9
  92. package/translated-docs/README.ko.md +13 -9
  93. package/translated-docs/README.pt-BR.md +13 -9
  94. package/translated-docs/README.zh-CN.md +13 -9
  95. package/translated-docs/README.zh-TW.md +13 -9
  96. package/translated-docs/docs/GETTING_STARTED.de.md +122 -69
  97. package/translated-docs/docs/GETTING_STARTED.es.md +121 -68
  98. package/translated-docs/docs/GETTING_STARTED.fr.md +125 -72
  99. package/translated-docs/docs/GETTING_STARTED.hi.md +124 -71
  100. package/translated-docs/docs/GETTING_STARTED.ja.md +125 -72
  101. package/translated-docs/docs/GETTING_STARTED.ko.md +124 -71
  102. package/translated-docs/docs/GETTING_STARTED.pt-BR.md +120 -67
  103. package/translated-docs/docs/GETTING_STARTED.zh-CN.md +126 -73
  104. package/translated-docs/docs/GETTING_STARTED.zh-TW.md +125 -72
  105. package/translated-docs/docs/PACKAGE_OVERVIEW.de.md +6 -4
  106. package/translated-docs/docs/PACKAGE_OVERVIEW.es.md +6 -4
  107. package/translated-docs/docs/PACKAGE_OVERVIEW.fr.md +6 -4
  108. package/translated-docs/docs/PACKAGE_OVERVIEW.hi.md +6 -4
  109. package/translated-docs/docs/PACKAGE_OVERVIEW.ja.md +6 -4
  110. package/translated-docs/docs/PACKAGE_OVERVIEW.ko.md +6 -4
  111. package/translated-docs/docs/PACKAGE_OVERVIEW.pt-BR.md +6 -4
  112. package/translated-docs/docs/PACKAGE_OVERVIEW.zh-CN.md +6 -4
  113. package/translated-docs/docs/PACKAGE_OVERVIEW.zh-TW.md +6 -4
package/README.md CHANGED
@@ -4,13 +4,13 @@ CLI and programmatic toolkit for internationalising JavaScript/TypeScript applic
4
4
 
5
5
 
6
6
  <small>**Read in other languages:** </small>
7
- <small id="lang-list">[en-GB](./README.md) · [de](./translated-docs/README.de.md) · [es](./translated-docs/README.es.md) · [fr](./translated-docs/README.fr.md) · [hi](./translated-docs/README.hi.md) · [ja](./translated-docs/README.ja.md) · [ko](./translated-docs/README.ko.md) · [pt-BR](./translated-docs/README.pt-BR.md) · [zh-CN](./translated-docs/README.zh-CN.md) · [zh-TW](./translated-docs/README.zh-TW.md)</small>
7
+ <small id="lang-list">[English (GB)](./README.md) · [German](./translated-docs/README.de.md) · [Spanish](./translated-docs/README.es.md) · [French](./translated-docs/README.fr.md) · [Hindi](./translated-docs/README.hi.md) · [Japanese](./translated-docs/README.ja.md) · [Korean](./translated-docs/README.ko.md) · [Portuguese (BR)](./translated-docs/README.pt-BR.md) · [Chinese (CN)](./translated-docs/README.zh-CN.md) · [Chinese (TW)](./translated-docs/README.zh-TW.md)</small>
8
8
 
9
9
  ## Two core workflows
10
10
 
11
11
  **Workflow 1 - UI Translation** (React, Next.js, Node.js, any i18next project)
12
12
 
13
- Scans source files for `t("…")` calls, builds a master catalog (`strings.json` with optional per-locale **`models`** metadata), translates missing entries per locale via OpenRouter, and writes flat JSON files (`de.json`, `pt-BR.json`, …) ready for i18next.
13
+ Builds a master catalog (`strings.json` with optional per-locale **`models`** metadata) from **`t("…")` / `i18n.t("…")` literals**, optionally **`package.json` `description`**, and optionally each **`englishName`** from `ui-languages.json` when enabled in config. Translates missing entries per locale via OpenRouter and writes flat JSON files (`de.json`, `pt-BR.json`, …) ready for i18next.
14
14
 
15
15
  **Workflow 2 - Document translation** (Markdown, Docusaurus JSON)
16
16
 
@@ -46,7 +46,7 @@ export OPENROUTER_API_KEY=sk-or-v1-your-key-here
46
46
  # 1. Create config
47
47
  npx ai-i18n-tools init
48
48
 
49
- # 2. Extract t("…") calls from source
49
+ # 2. Extract UI strings to strings.json (t(…) literals + optional package.json / manifest strings)
50
50
  npx ai-i18n-tools extract
51
51
 
52
52
  # 3. Translate to all target locales
@@ -125,8 +125,11 @@ Exported from `'ai-i18n-tools/runtime'` - work in any JS environment, no i18next
125
125
  ## CLI commands
126
126
 
127
127
  ```
128
+ ai-i18n-tools version Print version and build timestamp
129
+ ai-i18n-tools help [command] Show global or per-command help (same as -h)
128
130
  ai-i18n-tools init [-t ui-markdown|ui-docusaurus] Create config file
129
- ai-i18n-tools extract Scan source for t("…") calls
131
+ ai-i18n-tools generate-ui-languages [--master path] [--dry-run] Build ui-languages.json from locales + master catalog (needs uiLanguagesPath)
132
+ ai-i18n-tools extract Merge scanner output, optional package.json description, optional manifest englishName into strings.json
130
133
  ai-i18n-tools translate-docs [--locale <code>] Translate documentation (markdown, JSON); see docs for
131
134
  --force-update, --force, --stats, --clear-cache,
132
135
  --prompt-format (xml | json-array | json-object)
@@ -134,21 +137,22 @@ ai-i18n-tools translate-svg [--locale <code>] Standalone SVG assets (featu
134
137
  ai-i18n-tools translate-ui [--locale <code>] Translate UI strings only; see --force, --dry-run
135
138
  ai-i18n-tools export-ui-xliff [--locale <code>] Export UI strings to XLIFF 2.0 (one file per locale); see --untranslated-only, -o
136
139
  ai-i18n-tools sync Extract UI strings, then translate UI strings, SVG, and docs
137
- ai-i18n-tools status Translation status per file × locale
140
+ ai-i18n-tools status [--max-columns <n>] UI strings per locale; markdown per file × locale in tables of up to n locales (default 9)
138
141
  ai-i18n-tools editor Open cache/glossary web editor
139
142
  ai-i18n-tools cleanup [--dry-run] [--no-backup] [--backup <path>] Runs sync --force-update, then cleans stale + orphaned cache rows; backs up SQLite by default
140
143
  ai-i18n-tools glossary-generate Create empty glossary CSV template
141
144
  ```
142
145
 
143
- All commands accept `-c <config>` (default: `ai-i18n-tools.config.json`), `-v` (verbose), and optional `-w` / `--write-logs [path]` to append console output to a log file (default: under the translation cache directory).
146
+ Global options on every command: `-c <config>` (default: `ai-i18n-tools.config.json`), `-v` (verbose), optional `-w` / `--write-logs [path]` to tee console output to a log file (default: under the translation cache directory), `-V` / `--version`, and `-h` / `--help`. See [Getting Started](docs/GETTING_STARTED.md#cli-reference) for per-command flags.
144
147
 
145
148
  ---
146
149
 
147
150
  ## Documentation
148
151
 
149
- - [Getting Started](docs/GETTING_STARTED.md) - full setup guide for both workflows, all CLI flags, and config field reference.
152
+ - [Getting Started](docs/GETTING_STARTED.md) - full setup guide for both workflows, CLI reference, and config field reference.
150
153
  - [Package Overview](docs/PACKAGE_OVERVIEW.md) - architecture, internals, programmatic API, and extension points.
151
- - [AI Agent Context](docs/ai-i18n-tools-context.md) - concise project context for agents and maintainers making code or config changes.
154
+ - [AI Agent Context](docs/ai-i18n-tools-context.md) - **for apps using the package:** integration prompts for downstream projects (copy into your repo’s agent rules).
155
+ - Maintainer internals for **this** repository: `dev/package-context.md` (clone-only; not on npm).
152
156
 
153
157
  ---
154
158