i18nsmith 0.4.3 → 0.6.0

package/README.md

@@ -0,0 +1,126 @@
+# i18nsmith CLI
+
+Command-line interface for i18nsmith - universal automated i18n.
+
+## Installation
+
+```bash
+npm install -g i18nsmith
+# or
+pnpm add -g i18nsmith
+```
+
+## Quick Start
+
+```bash
+# Initialize project
+i18nsmith init
+
+# Scan for translation candidates
+i18nsmith scan
+
+# Sync locale files with code
+i18nsmith sync
+
+# Run health checks
+i18nsmith check
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `init` | Initialize i18n configuration |
+| `scan` | Scan source files for hardcoded text |
+| `sync` | Synchronize locale files with code references |
+| `check` | Run validation checks on locales |
+| `transform` | Transform hardcoded strings to i18n calls |
+| `rename` | Rename translation keys |
+| `diagnose` | Generate diagnostic report |
+| `backup` | Backup/restore locale files |
+| `detect` | Auto-detect project configuration |
+| `review` | Review borderline candidates interactively |
+| `translate` | Translate using external services |
+| `coverage` | Show translation coverage stats |
+| `preflight` | Validate setup before operations |
+| `scaffold-adapter` | Scaffold translation adapter files |
+
+## Architecture
+
+The CLI follows **Hexagonal Architecture** principles. Commands use `ServiceContainer` for dependency injection:
+
+```typescript
+import { getServiceContainer } from '../utils/bootstrap.js';
+import { CliError, withErrorHandling } from '../utils/errors.js';
+
+export function registerMyCommand(program: Command) {
+  program
+    .command('my-command')
+    .action(withErrorHandling(async (options) => {
+      const { config, projectRoot } = await loadConfigWithMeta(options.config);
+      const container = getServiceContainer({ workspaceRoot: projectRoot });
+      
+      const result = await container.scanner.scan(config);
+      if (!result.success) {
+        throw new CliError(result.error.message);
+      }
+      
+      // Use result.data
+    }));
+}
+```
+
+### Service Container
+
+The CLI bootstrap (`src/utils/bootstrap.ts`) configures:
+
+- `NodeFileSystem` - Node.js file operations
+- `CliLoggerFactory` - Console logging with chalk formatting
+
+### Commands Using ServiceContainer
+
+| Command | Services Used |
+|---------|--------------|
+| `scan` | `scanner` |
+| `sync` | `keyRenamer` |
+| `check` | `check` |
+| `diagnose` | `diagnostics` |
+| `detect` | `projectIntelligence` |
+| `backup` | `backup` |
+| `rename` | `keyRenamer` |
+| `coverage` | `diagnostics` |
+| `init` | `scanner`, `keyGenerator`, `projectIntelligence` |
+| `review` | `scanner` |
+| `scaffold-adapter` | `diagnostics` |
+
+## Development
+
+```bash
+# Build
+pnpm build
+
+# Test
+pnpm test
+
+# Run locally
+node dist/index.js <command>
+```
+
+## Adding New Commands
+
+1. Create command in `src/commands/my-command.ts`
+2. Use `getServiceContainer()` for service access
+3. Handle `Result<T>` pattern for error handling
+4. Register in `src/index.ts`
+
+See [CONTRIBUTING.md](../../CONTRIBUTING.md) for detailed patterns.
+
+## Related Documentation
+
+| Document | Purpose |
+|----------|---------|
+| [ARCHITECTURE.md](../../ARCHITECTURE.md) | System architecture, Hexagonal pattern |
+| [CONTRIBUTING.md](../../CONTRIBUTING.md) | Contribution guidelines |
+| [docs/schema.md](../../docs/schema.md) | Configuration schema reference |
+| [docs/best-practices.md](../../docs/best-practices.md) | Usage best practices |
+| [@i18nsmith/core README](../core/README.md) | Core library documentation |

package/build.mjs

@@ -17,6 +17,11 @@ console.log('Bundling CLI as a single, self-contained CommonJS file (no external
 
 // Produce a single CommonJS bundle so `npx`/npm-installed binaries run consistently
 // (some deps perform dynamic require() calls which fail under ESM bundles).
+// Run a static check to prevent accidentally introducing top-level await in
+// packages that are bundled into the CJS CLI. Top-level await breaks esbuild
+// when producing `format: 'cjs'` bundles.
+await import('../../scripts/check-no-top-level-await.mjs').then((m) => m.default());
+
 await esbuild.build({
   entryPoints: ['src/index.ts'],
   bundle: true,

package/dist/commands/backup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"backup.d.ts","sourceRoot":"","sources":["../../src/commands/backup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMpC;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CA0FrD"}
+{"version":3,"file":"backup.d.ts","sourceRoot":"","sources":["../../src/commands/backup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMpC;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CA4GrD"}

package/dist/commands/check.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAczC,UAAU,mBAAmB;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AA0HD,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,QAuB7C;AAED,wBAAsB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6H1E"}
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAezC,UAAU,mBAAmB;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AA0HD,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,QAuB7C;AAED,wBAAsB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwI1E"}

package/dist/commands/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/commands/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA8GzC,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QA2K9C"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/commands/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA8GzC,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QAyS9C"}

package/dist/commands/coverage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coverage.d.ts","sourceRoot":"","sources":["../../src/commands/coverage.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,UAAU,sBAAsB;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AA2CD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,QAUhD;AAED,wBAAsB,WAAW,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BhF"}
+{"version":3,"file":"coverage.d.ts","sourceRoot":"","sources":["../../src/commands/coverage.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMzC,UAAU,sBAAsB;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AA2CD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,QAUhD;AAED,wBAAsB,WAAW,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAiChF"}

package/dist/commands/detect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"detect.d.ts","sourceRoot":"","sources":["../../src/commands/detect.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAgSzC,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QAkD9C"}
+{"version":3,"file":"detect.d.ts","sourceRoot":"","sources":["../../src/commands/detect.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAgSzC,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QAyD9C"}

package/dist/commands/diagnose.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"diagnose.d.ts","sourceRoot":"","sources":["../../src/commands/diagnose.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAgGzC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,QAuChD"}
+{"version":3,"file":"diagnose.d.ts","sourceRoot":"","sources":["../../src/commands/diagnose.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAiGzC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,QAgDhD"}

package/dist/commands/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAWpC;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAwBrD;AAsTD,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,QAgZ5C"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAYpC;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAwBrD;AAsVD,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,QA6Z5C"}

package/dist/commands/rename.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rename.d.ts","sourceRoot":"","sources":["../../src/commands/rename.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA4BpC;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAsIrD"}
+{"version":3,"file":"rename.d.ts","sourceRoot":"","sources":["../../src/commands/rename.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA6BpC;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAwJrD"}

package/dist/commands/review.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../src/commands/review.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAgBzC,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAG3D;AAyGD,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QAkG9C"}
+{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../src/commands/review.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAiBzC,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAG3D;AAyGD,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QAwG9C"}

package/dist/commands/scaffold-adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scaffold-adapter.d.ts","sourceRoot":"","sources":["../../src/commands/scaffold-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAiCpC,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,OAAO,QAqMvD"}
+{"version":3,"file":"scaffold-adapter.d.ts","sourceRoot":"","sources":["../../src/commands/scaffold-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAkCpC,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,OAAO,QAqMvD"}

package/dist/commands/scan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scan.d.ts","sourceRoot":"","sources":["../../src/commands/scan.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA4CzC,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,QAmF5C"}
+{"version":3,"file":"scan.d.ts","sourceRoot":"","sources":["../../src/commands/scan.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA6CzC,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,QA+F5C"}

package/dist/commands/sync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../src/commands/sync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAyFpC,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,QA8nB5C"}
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../src/commands/sync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA0FpC,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,QA8oB5C"}

package/dist/commands/transform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../src/commands/transform.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA2LzC,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,QAgJjD"}
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../src/commands/transform.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA2LzC,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,QAuJjD"}