@shipi18n/cli 1.1.3 → 1.1.4

package/README.md

@@ -26,6 +26,7 @@ Command-line tool for translating locale files with [Shipi18n](https://shipi18n.
 - ✅ **Placeholder preservation** - Keep `{name}`, `{{value}}`, `%s`, etc. intact
 - ✅ **Key-based pricing** - 100 free translation keys (unlimited characters!)
 - ✅ **Language limits enforced** - FREE: 3 languages, STARTER: 10, PRO: unlimited
+- ✅ **ZIP output** - Bundle translations into a single downloadable ZIP file
 - ✅ **Config file support** - Save settings in `~/.shipi18n/config.yml`
 - ✅ **Translation Memory** - Manage keys with `shipi18n keys` commands
 - ✅ **Beautiful output** - Colored, formatted terminal output
@@ -104,6 +105,11 @@ shipi18n translate <input> [options]
   - `preserve` - Keep HTML tags and translate text between them
 - `--no-fallback` - Disable fallback to source for missing translations
 - `--no-regional-fallback` - Disable regional fallback (e.g., pt-BR → pt)
+- `-i, --incremental` - Only translate new/missing keys (skip existing translations)
+- `--skip-keys <keys>` - Keys to skip from translation (comma-separated exact paths)
+- `--skip-paths <patterns>` - Path patterns to skip (comma-separated, supports wildcards like `nav.*`)
+- `--context-file <path>` - JSON file with context annotations for disambiguation
+- `--zip [filename]` - Output translations as a single ZIP file (default: `translations.zip`)
 
 **Examples:**
 
@@ -125,6 +131,23 @@ shipi18n translate en.json --target es,pt-BR,zh-TW
 
 # Disable fallback (strict mode - fail if translation missing)
 shipi18n translate en.json --target es --no-fallback
+
+# Skip specific keys from translation (e.g., US state names, brand names)
+shipi18n translate en.json --target es --skip-keys "states.CA,states.NY,company.name"
+
+# Skip keys using glob patterns (e.g., all states, all config secrets)
+shipi18n translate en.json --target es --skip-paths "states.*,config.*.secret"
+
+# Combined - skip exact keys and patterns
+shipi18n translate en.json --target es,fr \
+  --skip-keys "brandName" \
+  --skip-paths "states.*,internal.*"
+
+# Output as ZIP file (default name: translations.zip)
+shipi18n translate en.json --target es,fr,de --zip
+
+# Output as ZIP with custom filename
+shipi18n translate en.json --target es,fr,de --zip my-translations.zip
 ```
 
 ### Fallback Behavior
@@ -163,6 +186,109 @@ shipi18n translate en.json --target es --no-fallback
 shipi18n translate en.json --target pt-BR --no-regional-fallback
 ```
 
+### Skipping Keys
+
+Exclude specific keys or patterns from translation - useful for brand names, US state codes, or config values that should stay in English:
+
+```bash
+# Skip exact key paths
+shipi18n translate en.json --target es --skip-keys "company.name,legal.terms"
+
+# Skip using glob patterns
+shipi18n translate en.json --target es --skip-paths "states.*,config.*.internal"
+```
+
+**Pattern Matching:**
+| Pattern | Matches |
+|---------|---------|
+| `states.CA` | Exact path only |
+| `states.*` | `states.CA`, `states.NY`, etc. (single level) |
+| `config.*.secret` | `config.api.secret`, `config.db.secret` |
+| `**.internal` | Any path ending with `.internal` |
+
+**Example output with skipped keys:**
+```
+✓ Translated 45 keys to 2 languages!
+ℹ Skipped 5 key(s) from translation:
+  • states.CA
+  • states.NY
+  • states.TX
+  • company.name
+  • config.api.secret
+
+✨ Successfully translated 2 files!
+```
+
+### Context Annotations
+
+Improve translation quality for ambiguous words by providing context hints:
+
+```bash
+# Create a context file
+echo '{"close": "button - dismiss window", "address": "form field - location"}' > context.json
+
+# Translate with context
+shipi18n translate en.json --target es --context-file context.json
+```
+
+**Example context.json:**
+```json
+{
+  "close": "button label - dismiss/shut a dialog",
+  "address": "form field - physical location/street address",
+  "post": "verb - publish content"
+}
+```
+
+**Result:** "close" → "Cerrar" (not "Cerca"), "address" → "Dirección" (not "Dirigirse")
+
+### Legal Content Warning
+
+The CLI automatically warns when translating keys that may contain legal content:
+
+```
+⚠️  Legal content detected - review these keys:
+  • terms_of_service
+  • privacy_policy
+  • disclaimer
+  Machine-translated legal text may not be legally binding.
+```
+
+**Detected patterns:** terms, privacy, disclaimer, legal, tos, eula, copyright, license, gdpr, cookie_policy, compliance, data_protection, refund, warranty
+
+### ZIP Output
+
+Bundle all translations into a single ZIP file for easy distribution:
+
+```bash
+# Default filename (translations.zip)
+shipi18n translate en.json --target es,fr,de,ja --zip
+
+# Custom filename
+shipi18n translate en.json --target es,fr,de,ja --zip locales-v2.zip
+
+# With custom output directory
+shipi18n translate en.json --target es,fr --zip --output ./dist/i18n
+```
+
+**Output:**
+```
+✔ Translated 50 keys to 4 languages!
+✓ Saved: ./locales/translations.zip (4 files)
+
+✨ Successfully translated 4 files!
+   Output: ./locales
+```
+
+**ZIP structure:**
+```
+translations.zip
+├── es.json
+├── fr.json
+├── de.json
+└── ja.json
+```
+
 ### Keys Management
 
 Manage your translation keys in Translation Memory:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipi18n/cli",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Command-line tool for translating locale files with Shipi18n",
   "main": "src/index.js",
   "type": "module",
@@ -42,12 +42,13 @@
   "author": "Shipi18n",
   "license": "MIT",
   "dependencies": {
-    "commander": "^11.1.0",
+    "archiver": "^7.0.1",
     "chalk": "^5.3.0",
+    "commander": "^11.1.0",
     "dotenv": "^16.3.1",
-    "yaml": "^2.3.4",
+    "inquirer": "^9.2.12",
     "ora": "^7.0.1",
-    "inquirer": "^9.2.12"
+    "yaml": "^2.3.4"
   },
   "devDependencies": {
     "jest": "^29.7.0"

package/src/commands/translate.js

@@ -1,6 +1,7 @@
-import { readFileSync, writeFileSync, mkdirSync, existsSync } from 'fs';
+import { readFileSync, writeFileSync, mkdirSync, existsSync, createWriteStream } from 'fs';
 import { join, parse, dirname } from 'path';
 import chalk from 'chalk';
+import archiver from 'archiver';
 import { Shipi18nAPI } from '../lib/api.js';
 import { getConfig } from '../lib/config.js';
 import { logger, formatError } from '../utils/logger.js';
@@ -19,6 +20,10 @@ export function translateCommand(program) {
     .option('--no-fallback', 'Disable fallback to source language for missing translations')
     .option('--no-regional-fallback', 'Disable regional fallback (e.g., pt-BR -> pt)')
     .option('-i, --incremental', 'Only translate new/missing keys (skip existing translations)')
+    .option('--skip-keys <keys>', 'Keys to skip from translation (comma-separated exact paths)')
+    .option('--skip-paths <patterns>', 'Paths to skip using wildcards (comma-separated, e.g., "states.*,config.*.secret")')
+    .option('--context-file <path>', 'JSON file with context annotations for disambiguation (e.g., {"close": "button - dismiss"})')
+    .option('--zip [filename]', 'Output translations as ZIP file (default: translations.zip)')
     .action(async (input, options) => {
       const spinner = logger.spinner('Translating...');
 
@@ -59,6 +64,38 @@ export function translateCommand(program) {
         const outputDir = options.output;
         const inputFileName = parse(input).name;
 
+        // Parse skip options
+        const skipKeys = options.skipKeys
+          ? options.skipKeys.split(',').map(k => k.trim())
+          : [];
+        const skipPaths = options.skipPaths
+          ? options.skipPaths.split(',').map(p => p.trim())
+          : [];
+
+        if (skipKeys.length > 0 || skipPaths.length > 0) {
+          logger.info(`Skipping ${skipKeys.length + skipPaths.length} key/pattern(s) from translation`);
+        }
+
+        // Parse context annotations file
+        let contextAnnotations = {};
+        if (options.contextFile) {
+          if (!existsSync(options.contextFile)) {
+            spinner.fail();
+            logger.error(`Context file not found: ${options.contextFile}`);
+            process.exit(1);
+          }
+          try {
+            const contextContent = readFileSync(options.contextFile, 'utf8');
+            contextAnnotations = JSON.parse(contextContent);
+            const contextCount = Object.keys(contextAnnotations).length;
+            logger.info(`Loaded ${contextCount} context annotation(s) from ${options.contextFile}`);
+          } catch (error) {
+            spinner.fail();
+            logger.error(`Invalid JSON in context file: ${error.message}`);
+            process.exit(1);
+          }
+        }
+
         // Incremental mode: load existing translations and find missing keys
         let jsonToTranslate = json;
         const existingTranslations = {};
@@ -137,6 +174,9 @@ export function translateCommand(program) {
             fallbackToSource: options.fallback !== false,
             regionalFallback: options.regionalFallback !== false,
           },
+          skipKeys,
+          skipPaths,
+          contextAnnotations,
         });
 
         const keyCount = Object.keys(flattenObject(jsonToTranslate)).length;
@@ -148,19 +188,50 @@ export function translateCommand(program) {
         }
 
         let savedCount = 0;
+
+        // Prepare translations for output (filter metadata, apply merging)
+        const outputTranslations = {};
         for (const [langCode, content] of Object.entries(translations)) {
-          if (langCode === 'warnings' || langCode === 'fallbackInfo' || langCode === 'namespaceInfo') continue;
+          if (langCode === 'warnings' || langCode === 'fallbackInfo' || langCode === 'namespaceInfo' || langCode === 'skipped' || langCode === 'contextEnhanced') continue;
 
-          // In incremental mode, merge with existing translations
           let finalContent = content;
           if (options.incremental && existingTranslations[langCode]) {
             finalContent = deepMerge(existingTranslations[langCode], content);
           }
+          outputTranslations[langCode] = finalContent;
+        }
+
+        if (options.zip) {
+          // ZIP output mode
+          const zipFileName = typeof options.zip === 'string' ? options.zip : 'translations.zip';
+          const zipPath = join(outputDir, zipFileName);
+
+          await new Promise((resolve, reject) => {
+            const output = createWriteStream(zipPath);
+            const archive = archiver('zip', { zlib: { level: 9 } });
+
+            output.on('close', resolve);
+            archive.on('error', reject);
+
+            archive.pipe(output);
+
+            for (const [langCode, content] of Object.entries(outputTranslations)) {
+              archive.append(JSON.stringify(content, null, 2), { name: `${langCode}.json` });
+              savedCount++;
+            }
+
+            archive.finalize();
+          });
 
-          const outputFile = join(outputDir, `${langCode}.json`);
-          writeFileSync(outputFile, JSON.stringify(finalContent, null, 2), 'utf8');
-          logger.success(`Saved: ${chalk.cyan(outputFile)}${options.incremental ? chalk.gray(' (merged)') : ''}`);
-          savedCount++;
+          logger.success(`Saved: ${chalk.cyan(zipPath)} (${savedCount} file${savedCount !== 1 ? 's' : ''})`);
+        } else {
+          // Individual files mode
+          for (const [langCode, content] of Object.entries(outputTranslations)) {
+            const outputFile = join(outputDir, `${langCode}.json`);
+            writeFileSync(outputFile, JSON.stringify(content, null, 2), 'utf8');
+            logger.success(`Saved: ${chalk.cyan(outputFile)}${options.incremental ? chalk.gray(' (merged)') : ''}`);
+            savedCount++;
+          }
         }
 
         // Show fallback info if any fallbacks were used
@@ -196,11 +267,52 @@ export function translateCommand(program) {
           }
         }
 
-        // Show warnings if any
-        if (translations.warnings && translations.warnings.length > 0) {
+        // Show skipped keys info if any
+        if (translations.skipped && translations.skipped.count > 0) {
+          logger.log('');
+          logger.info(`Skipped ${translations.skipped.count} key${translations.skipped.count > 1 ? 's' : ''} from translation:`);
+          const keysToShow = translations.skipped.keys.slice(0, 10);
+          keysToShow.forEach(key => {
+            logger.log(`  ${chalk.gray('•')} ${key}`);
+          });
+          if (translations.skipped.keys.length > 10) {
+            logger.log(`  ${chalk.gray(`... and ${translations.skipped.keys.length - 10} more`)}`);
+          }
+        }
+
+        // Show context-enhanced keys info if any
+        if (translations.contextEnhanced && translations.contextEnhanced.count > 0) {
+          logger.log('');
+          logger.info(`${chalk.cyan('🎯')} ${translations.contextEnhanced.count} key${translations.contextEnhanced.count > 1 ? 's' : ''} translated with context annotations:`);
+          const keysToShow = translations.contextEnhanced.keys.slice(0, 10);
+          keysToShow.forEach(key => {
+            logger.log(`  ${chalk.cyan('•')} ${key}`);
+          });
+          if (translations.contextEnhanced.keys.length > 10) {
+            logger.log(`  ${chalk.gray(`... and ${translations.contextEnhanced.keys.length - 10} more`)}`);
+          }
+        }
+
+        // Show legal content warning with key details
+        const legalWarning = translations.warnings?.find(w => w.type === 'legal_content');
+        if (legalWarning?.details?.keys?.length > 0) {
+          logger.log('');
+          logger.warn(`${chalk.yellow('⚠️')}  Legal content detected - review these keys:`);
+          legalWarning.details.keys.forEach(key => {
+            logger.log(`  ${chalk.yellow('•')} ${key}`);
+          });
+          if (legalWarning.details.count > 10) {
+            logger.log(`  ${chalk.gray(`... and ${legalWarning.details.count - 10} more`)}`);
+          }
+          logger.log(`  ${chalk.gray('Machine-translated legal text may not be legally binding.')}`);
+        }
+
+        // Show other warnings if any (exclude legal_content since we showed it above)
+        const otherWarnings = translations.warnings?.filter(w => w.type !== 'legal_content') || [];
+        if (otherWarnings.length > 0) {
           logger.log('');
           logger.warn('Warnings:');
-          translations.warnings.forEach(warning => {
+          otherWarnings.forEach(warning => {
             logger.log(`  ${chalk.yellow('•')} ${warning.message}`);
           });
         }

package/src/lib/api.js

@@ -24,6 +24,9 @@ export class Shipi18nAPI {
    * @param {boolean} options.fallback.fallbackToSource - Use source content when translation missing (default: true)
    * @param {boolean} options.fallback.regionalFallback - Enable pt-BR -> pt fallback (default: true)
    * @param {string} options.fallback.fallbackLanguage - Custom fallback language
+   * @param {string[]} options.skipKeys - Exact key paths to skip from translation
+   * @param {string[]} options.skipPaths - Glob patterns to skip (e.g., "nav.*", "config.*.secret")
+   * @param {Object} options.contextAnnotations - Per-key context hints for disambiguation
    */
   async translateJSON({
     json,
@@ -31,7 +34,10 @@ export class Shipi18nAPI {
     targetLanguages,
     preservePlaceholders = true,
     htmlHandling = 'none',
-    fallback = {}
+    fallback = {},
+    skipKeys = [],
+    skipPaths = [],
+    contextAnnotations = {},
   }) {
     if (!this.apiKey) {
       throw new Error('API key is required. Set SHIPI18N_API_KEY or run: shipi18n config set apiKey YOUR_KEY');
@@ -62,6 +68,9 @@ export class Shipi18nAPI {
         targetLanguages: JSON.stringify(processedTargets),
         preservePlaceholders: String(preservePlaceholders),
         htmlHandling,
+        skipKeys,
+        skipPaths,
+        contextAnnotations,
       }),
     });
 
@@ -78,7 +87,7 @@ export class Shipi18nAPI {
     // Parse JSON strings back to objects
     const parsed = {};
     for (const [lang, jsonStr] of Object.entries(result)) {
-      if (lang === 'warnings' || lang === 'namespaceInfo') {
+      if (lang === 'warnings' || lang === 'namespaceInfo' || lang === 'skipped' || lang === 'contextEnhanced') {
         parsed[lang] = jsonStr;
         continue;
       }