@mariokreitz/langsync 0.5.0 → 0.7.0

package/README.md

@@ -3,6 +3,8 @@
 > Modern localization workflow tooling for TypeScript applications.
 
 [![npm version](https://img.shields.io/npm/v/@mariokreitz/langsync.svg?style=flat-square&color=2563eb)](https://www.npmjs.com/package/@mariokreitz/langsync)
+[![CI](https://img.shields.io/github/actions/workflow/status/mariokreitz/langsync/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/mariokreitz/langsync/actions/workflows/ci.yml)
+[![codecov](https://img.shields.io/codecov/c/github/mariokreitz/langsync?style=flat-square)](https://codecov.io/gh/mariokreitz/langsync)
 [![Node](https://img.shields.io/node/v/@mariokreitz/langsync?style=flat-square&color=2563eb)](https://nodejs.org)
 [![License](https://img.shields.io/npm/l/@mariokreitz/langsync.svg?style=flat-square)](https://github.com/mariokreitz/langsync/blob/main/LICENSE)
 
@@ -14,7 +16,7 @@ chaos of hand-edited JSON or fragile Excel hand-offs.
 - **Bidirectional Excel I/O** for non-technical translators.
 - **Strict validation** with CI-friendly exit codes and JSON output.
 - **Auto-detected integrations** for `i18next`, `ngx-translate`, `react-intl`.
-- **Interactive setup** that scaffolds your config and locale files.
+- **Interactive setup** that scaffolds your config and single-file or namespaced locale files.
 
 ## Install
 
@@ -59,16 +61,16 @@ npx langsync import excel
 | Command                 | Description                                                         |
 | ----------------------- | ------------------------------------------------------------------- |
 | `langsync init`         | Initialize a typed `langsync.config.ts` and scaffold locale files.  |
-| `langsync validate`     | Report missing, extra, and empty keys; exits non-zero on errors.    |
+| `langsync validate`     | Report missing, extra, and empty keys across locales/namespaces.    |
 | `langsync find-missing` | Report missing keys per locale; exits non-zero on errors.           |
-| `langsync sync`         | Synchronize keys from the reference locale into every other locale. |
+| `langsync sync`         | Synchronize reference keys into each target locale or namespace.    |
 | `langsync translate`    | Fill empty values in non-reference locales using an AI provider.    |
 | `langsync watch`        | Watch locale files and run incremental sync + validation on change. |
-| `langsync export excel` | Export all locales into a single `.xlsx` workbook.                  |
-| `langsync import excel` | Import translations from a workbook back into JSON files.           |
+| `langsync export excel` | Export locales/namespaces into a single `.xlsx` workbook.           |
+| `langsync import excel` | Import workbook translations back into configured JSON files.       |
 
-All read commands support `--reporter json`. All write commands support
-`--dry-run`.
+The `validate` and `find-missing` commands support `--reporter json`. The
+`sync`, `translate`, and `import excel` commands support `--dry-run`.
 
 ## Configuration
 
@@ -83,6 +85,9 @@ export default defineConfig({
   locales: ['en', 'de', 'fr'],
   defaultLocale: 'en',
   framework: 'i18next',
+  // Opt in to namespaced files when your project outgrows one file per locale.
+  // namespaces: { structure: 'locale-dir' }, // ./src/i18n/en/common.json
+  // namespaces: { structure: 'locale-prefix' }, // ./src/i18n/en.common.json
   excel: {
     file: 'translations.xlsx',
     sheetName: 'Translations',
@@ -95,14 +100,31 @@ export default defineConfig({
 ```
 
 JSON, JS, and MJS configs are also supported via cosmiconfig. Omit `framework`
-or set `framework: 'none'` for custom setups.
+or set `framework: 'none'` for custom setups. Omit `namespaces` for the default
+`<input>/<locale>.json` layout, or set `namespaces.structure` to `locale-dir`
+or `locale-prefix` for per-namespace files.
+
+## SDK
+
+Besides the CLI, LangSync ships a standalone SDK — `@mariokreitz/langsync-sdk` —
+that exports the command runners (`runValidate`, `runSync`, `runFindMissing`,
+`runTranslate`) as in-process, side-effect-free functions. Use it to drive the
+same workflows from Node.js — editor integrations, custom scripts, or CI tooling
+— without shelling out.
+
+```bash
+npm install @mariokreitz/langsync-sdk
+```
+
+See the [SDK reference](https://docs.langsync.kreitz-webdev.de/docs/sdk) for the
+full surface, options, and result types.
 
 ## Documentation
 
-Full documentation, including configuration reference, every CLI command,
-and framework integration recipes:
+Full documentation — configuration reference, every CLI command, the VS Code
+extension, the SDK, and framework integration recipes:
 
-**https://github.com/mariokreitz/langsync**
+**https://docs.langsync.kreitz-webdev.de**
 
 ## License
 

package/dist/cli.d.ts

@@ -1 +1 @@
-import '@langsync/shared/config';
+import '@mariokreitz/langsync-sdk';