@formatjs/cli-lib 7.4.4 → 8.0.1

package/{lib_esnext/index.d.ts → index.d.ts}

@@ -1,7 +1,7 @@
-export { default as extractAndWrite, extract } from './src/extract';
-export type { ExtractCLIOptions, ExtractOpts } from './src/extract';
+export { default as extractAndWrite, extract } from './src/extract.js';
+export type { ExtractCLIOptions, ExtractOpts } from './src/extract.js';
 export type { MessageDescriptor } from '@formatjs/ts-transformer';
-export type { FormatFn, CompileFn } from './src/formatters/default';
+export type { FormatFn, CompileFn } from './src/formatters/default.js';
 export type { Comparator } from 'json-stable-stringify';
-export { default as compileAndWrite, compile } from './src/compile';
-export type { CompileCLIOpts, Opts as CompileOpts } from './src/compile';
+export { default as compileAndWrite, compile } from './src/compile.js';
+export type { CompileCLIOpts, Opts as CompileOpts } from './src/compile.js';

package/{lib_esnext/index.js → index.js}

@@ -1,2 +1,2 @@
-export { default as extractAndWrite, extract } from './src/extract';
-export { default as compileAndWrite, compile } from './src/compile';
+export { default as extractAndWrite, extract } from './src/extract.js';
+export { default as compileAndWrite, compile } from './src/compile.js';

package/{lib_esnext/main.d.ts → main.d.ts}

@@ -1 +1,2 @@
 #!/usr/bin/env node
+export {};

package/main.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import cli from './src/cli.js';
+cli(process.argv);

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@formatjs/cli-lib",
   "description": "Lib for CLI for formatjs.",
-  "version": "7.4.4",
+  "version": "8.0.1",
   "license": "MIT",
   "author": "Linjie Ding <linjie@airtable.com>",
+  "type": "module",
   "engines": {
     "node": ">= 16"
   },
@@ -19,9 +20,9 @@
     "loud-rejection": "^2",
     "tslib": "^2.8.0",
     "typescript": "^5.6.0",
-    "@formatjs/icu-messageformat-parser": "2.11.4",
-    "@formatjs/ts-transformer": "3.14.2",
-    "@formatjs/icu-skeleton-parser": "1.8.16"
+    "@formatjs/icu-messageformat-parser": "3.0.1",
+    "@formatjs/ts-transformer": "4.0.1",
+    "@formatjs/icu-skeleton-parser": "2.0.1"
   },
   "peerDependencies": {
     "@glimmer/syntax": "^0.95.0",

package/{lib_esnext/src → src}/cli.js

@@ -1,11 +1,11 @@
 import { program } from 'commander';
 import { sync as globSync } from 'fast-glob';
 import loudRejection from 'loud-rejection';
-import compile from './compile';
-import compileFolder from './compile_folder';
-import { debug } from './console_utils';
-import extract from './extract';
-import { verify } from './verify';
+import compile from './compile.js';
+import compileFolder from './compile_folder.js';
+import { debug } from './console_utils.js';
+import extract from './extract.js';
+import { verify } from './verify/index.js';
 import { readFileSync } from 'fs-extra';
 import { resolve } from 'path';
 const KNOWN_COMMANDS = ['extract'];
@@ -167,6 +167,7 @@ This is especially useful to convert from a TMS-specific format back to react-in
         .option('--ignore <files...>', 'List of glob paths to ignore')
         .option('--missing-keys', `Whether to check for missing keys in target locale compared to source locale. 
       This basically guarantees that no messages are untranslated.`)
+        .option('--extra-keys', `Whether to check that target locales don't have extra keys not present in the source locale.`)
         .option('--structural-equality', `Whether to check for structural equality of messages between source and target locale. 
       This makes sure translations are formattable and are not missing any tokens.`)
         .action(async (filePatterns, opts) => {

package/{lib_esnext/src → src}/compile.d.ts

@@ -1,4 +1,4 @@
-import { Formatter } from './formatters';
+import { Formatter } from './formatters/index.js';
 export type CompileFn = (msgs: any) => Record<string, string>;
 export type PseudoLocale = 'xx-LS' | 'xx-AC' | 'xx-HA' | 'en-XA' | 'en-XB';
 export interface CompileCLIOpts extends Opts {

package/{lib_esnext/src → src}/compile.js

@@ -1,9 +1,10 @@
 import { parse } from '@formatjs/icu-messageformat-parser';
 import { outputFile, readJSON } from 'fs-extra';
-import stringify from 'json-stable-stringify';
-import { debug, warn, writeStdout } from './console_utils';
-import { resolveBuiltinFormatter } from './formatters';
-import { generateENXA, generateENXB, generateXXAC, generateXXHA, generateXXLS, } from './pseudo_locale';
+import * as stringifyNs from 'json-stable-stringify';
+import { debug, warn, writeStdout } from './console_utils.js';
+import { resolveBuiltinFormatter } from './formatters/index.js';
+import { generateENXA, generateENXB, generateXXAC, generateXXHA, generateXXLS, } from './pseudo_locale.js';
+const stringify = stringifyNs.default || stringifyNs;
 /**
  * Aggregate `inputFiles` into a single JSON blob and compile.
  * Also checks for conflicting IDs.

package/{lib_esnext/src → src}/compile_folder.d.ts

@@ -1,2 +1,2 @@
-import { Opts } from './compile';
+import { Opts } from './compile.js';
 export default function compileFolder(files: string[], outFolder: string, opts?: Opts): Promise<void[]>;

package/{lib_esnext/src → src}/compile_folder.js

@@ -1,6 +1,6 @@
 import { outputFile } from 'fs-extra';
 import { basename, join } from 'path';
-import { compile } from './compile';
+import { compile } from './compile.js';
 export default async function compileFolder(files, outFolder, opts = {}) {
     const results = await Promise.all(files.map(f => compile([f], opts)));
     const outFiles = files.map(f => join(outFolder, basename(f)));

package/{lib_esnext/src → src}/console_utils.js

@@ -1,15 +1,14 @@
-import { green, red, supportsColor, yellow } from 'chalk';
-import readline from 'readline';
+import * as chalkNs from 'chalk';
+import { clearLine as nativeClearLine, cursorTo as nativeCursorTo, } from 'readline';
 import { format, promisify } from 'util';
+const chalk = chalkNs.default ?? chalkNs;
 const CLEAR_WHOLE_LINE = 0;
 export const writeStderr = promisify(process.stderr.write).bind(process.stderr);
 export const writeStdout = promisify(process.stdout.write).bind(process.stdout);
-const nativeClearLine = promisify(readline.clearLine).bind(readline);
-const nativeCursorTo = promisify(readline.cursorTo).bind(readline);
 // From:
 // https://github.com/yarnpkg/yarn/blob/53d8004229f543f342833310d5af63a4b6e59c8a/src/reporters/console/util.js
 export async function clearLine(terminal) {
-    if (!supportsColor) {
+    if (!chalk.supportsColor) {
         if (terminal.isTTY) {
             // terminal
             if (terminal.columns > 0) {
@@ -20,14 +19,14 @@ export async function clearLine(terminal) {
         // ignore piping to file
     }
     else {
-        await nativeClearLine(terminal, CLEAR_WHOLE_LINE);
-        await nativeCursorTo(terminal, 0, undefined);
+        nativeClearLine(terminal, CLEAR_WHOLE_LINE);
+        nativeCursorTo(terminal, 0, undefined);
     }
 }
 const LEVEL_COLORS = {
-    debug: green,
-    warn: yellow,
-    error: red,
+    debug: chalk.green,
+    warn: chalk.yellow,
+    error: chalk.red,
 };
 function label(level, message) {
     return `[@formatjs/cli] [${LEVEL_COLORS[level](level.toUpperCase())}] ${message}`;

package/{lib_esnext/src → src}/extract.d.ts

@@ -1,5 +1,5 @@
 import { MessageDescriptor, Opts } from '@formatjs/ts-transformer';
-import { Formatter } from './formatters';
+import { Formatter } from './formatters/index.js';
 export interface ExtractionResult<M = Record<string, string>> {
     /**
      * List of extracted messages

package/{lib_esnext/src → src}/extract.js

@@ -1,12 +1,13 @@
 import { interpolateName, } from '@formatjs/ts-transformer';
 import { outputFile, readFile } from 'fs-extra';
-import { debug, getStdinAsString, warn, writeStdout } from './console_utils';
+import { debug, getStdinAsString, warn, writeStdout } from './console_utils.js';
+import * as stringifyNs from 'json-stable-stringify';
 import { parse } from '@formatjs/icu-messageformat-parser';
-import { hoistSelectors } from '@formatjs/icu-messageformat-parser/manipulator';
-import { printAST } from '@formatjs/icu-messageformat-parser/printer';
-import stringify from 'json-stable-stringify';
-import { resolveBuiltinFormatter } from './formatters';
-import { parseScript } from './parse_script';
+import { hoistSelectors } from '@formatjs/icu-messageformat-parser/manipulator.js';
+import { printAST } from '@formatjs/icu-messageformat-parser/printer.js';
+import { resolveBuiltinFormatter } from './formatters/index.js';
+import { parseScript } from './parse_script.js';
+const stringify = stringifyNs.default || stringifyNs;
 function calculateLineColFromOffset(text, start) {
     if (!start) {
         return { line: 1, col: 1 };

package/{lib_esnext/src → src}/formatters/crowdin.d.ts

@@ -1,4 +1,4 @@
-import { CompileFn, FormatFn } from './default';
+import { CompileFn, FormatFn } from './default.js';
 export type CrowdinJson = Record<string, {
     message: string;
     description?: string;

package/{lib_esnext/src → src}/formatters/index.d.ts

@@ -1,5 +1,5 @@
 import type { Comparator } from 'json-stable-stringify';
-import { CompileFn, FormatFn, SerializeFn } from './default';
+import { CompileFn, FormatFn, SerializeFn } from './default.js';
 export interface Formatter<T> {
     serialize?: SerializeFn<T>;
     format: FormatFn<T>;

package/{lib_esnext/src → src}/formatters/index.js

@@ -1,11 +1,11 @@
 import { resolve } from 'path';
 import { pathToFileURL } from 'url';
-import * as crowdin from './crowdin';
-import * as defaultFormatter from './default';
-import * as lokalise from './lokalise';
-import * as simple from './simple';
-import * as smartling from './smartling';
-import * as transifex from './transifex';
+import * as crowdin from './crowdin.js';
+import * as defaultFormatter from './default.js';
+import * as lokalise from './lokalise.js';
+import * as simple from './simple.js';
+import * as smartling from './smartling.js';
+import * as transifex from './transifex.js';
 export async function resolveBuiltinFormatter(format) {
     if (!format) {
         return defaultFormatter;

package/{lib_esnext/src → src}/formatters/lokalise.d.ts

@@ -1,4 +1,4 @@
-import { CompileFn, FormatFn } from './default';
+import { CompileFn, FormatFn } from './default.js';
 export type StructuredJson = Record<string, {
     translation: string;
     notes?: string;

package/{lib_esnext/src → src}/formatters/simple.d.ts

@@ -1,4 +1,4 @@
-import { CompileFn, FormatFn } from './default';
+import { CompileFn, FormatFn } from './default.js';
 export type PhraseJson = Record<string, string>;
 export declare const format: FormatFn<PhraseJson>;
 export declare const compile: CompileFn<PhraseJson>;

package/{lib_esnext/src → src}/formatters/smartling.d.ts

@@ -1,5 +1,5 @@
 import type { Comparator } from 'json-stable-stringify';
-import { CompileFn, FormatFn } from './default';
+import { CompileFn, FormatFn } from './default.js';
 export interface SmartlingDirectives {
     translate_paths: [
         {

package/{lib_esnext/src → src}/formatters/transifex.d.ts

@@ -1,4 +1,4 @@
-import { CompileFn, FormatFn } from './default';
+import { CompileFn, FormatFn } from './default.js';
 export type StructuredJson = Record<string, {
     string: string;
     developer_comment?: string;

package/{lib_esnext/src → src}/gts_extractor.js

@@ -1,6 +1,6 @@
 import { Preprocessor } from 'content-tag';
-import { parseFile as parseHbsFile } from './hbs_extractor';
-import { parseScript } from './parse_script';
+import { parseFile as parseHbsFile } from './hbs_extractor.js';
+import { parseScript } from './parse_script.js';
 let p = new Preprocessor();
 export function parseFile(source, fileName, options) {
     const scriptParseFn = parseScript(options, fileName);

package/{lib_esnext/src → src}/parse_script.js

@@ -1,6 +1,6 @@
 import { transformWithTs } from '@formatjs/ts-transformer';
-import ts from 'typescript';
-import { debug } from './console_utils';
+import * as ts from 'typescript';
+import { debug } from './console_utils.js';
 /**
  * Invoid TypeScript module transpilation with our TS transformer
  * @param opts Formatjs TS Transformer opt

package/src/verify/checkExtraKeys.d.ts

@@ -0,0 +1 @@
+export declare function checkExtraKeys(translationFilesContents: Record<string, any>, sourceLocale: string): Promise<boolean>;

package/src/verify/checkExtraKeys.js

@@ -0,0 +1,36 @@
+import { debug, writeStderr } from '../console_utils.js';
+/**
+ * Flatten nested obj into list of keys, delimited by `.`
+ * @param obj
+ * @param parentKey
+ * @returns
+ */
+function extractKeys(obj, parentKey = '') {
+    if (!obj || typeof obj !== 'object' || Array.isArray(obj)) {
+        return [];
+    }
+    return Object.keys(obj)
+        .map(k => [parentKey ? `${parentKey}.${k}` : k, ...extractKeys(obj[k], k)])
+        .flat();
+}
+export async function checkExtraKeys(translationFilesContents, sourceLocale) {
+    debug('Checking translation files:');
+    const sourceContent = translationFilesContents[sourceLocale];
+    if (!sourceContent) {
+        throw new Error(`Missing source ${sourceLocale}.json file`);
+    }
+    const sourceKeys = extractKeys(sourceContent);
+    return Object.entries(translationFilesContents)
+        .filter(([locale]) => locale !== sourceLocale)
+        .reduce((result, [locale, content]) => {
+        const localeKeys = new Set(extractKeys(content));
+        const extraKeys = new Set(Array.from(localeKeys).filter(k => !sourceKeys.includes(k)));
+        if (!extraKeys.size) {
+            return result;
+        }
+        writeStderr('---------------------------------\n');
+        writeStderr(`Extra translation keys for locale ${locale}:\n`);
+        extraKeys.forEach(r => writeStderr(`${r}\n`));
+        return false;
+    }, true);
+}

package/{lib_esnext/src → src}/verify/checkMissingKeys.js

@@ -1,4 +1,4 @@
-import { debug, writeStderr } from '../console_utils';
+import { debug, writeStderr } from '../console_utils.js';
 /**
  * Flatten nested obj into list of keys, delimited by `.`
  * @param obj
@@ -15,16 +15,16 @@ function extractKeys(obj, parentKey = '') {
 }
 export async function checkMissingKeys(translationFilesContents, sourceLocale) {
     debug('Checking translation files:');
-    const enUSContent = translationFilesContents[sourceLocale];
-    if (!enUSContent) {
+    const sourceContent = translationFilesContents[sourceLocale];
+    if (!sourceContent) {
         throw new Error(`Missing source ${sourceLocale}.json file`);
     }
-    const enUSKeys = extractKeys(enUSContent);
+    const sourceKeys = extractKeys(sourceContent);
     return Object.entries(translationFilesContents)
         .filter(([locale]) => locale !== sourceLocale)
         .reduce((result, [locale, content]) => {
         const localeKeys = new Set(extractKeys(content));
-        const missingKeys = new Set(enUSKeys.filter(r => !localeKeys.has(r)));
+        const missingKeys = new Set(sourceKeys.filter(r => !localeKeys.has(r)));
         // We're being lenient here since only missing keys are currently considered breaking
         if (!missingKeys.size) {
             return result;

package/{lib_esnext/src → src}/verify/checkStructuralEquality.js

@@ -1,5 +1,5 @@
 import { isStructurallySame, parse, } from '@formatjs/icu-messageformat-parser';
-import { debug, writeStderr } from '../console_utils';
+import { debug, writeStderr } from '../console_utils.js';
 import { error } from 'console';
 /**
  * Flatten nested obj into list of keys, delimited by `.`
@@ -25,11 +25,11 @@ function flatten(obj, parentKey = '') {
 }
 export async function checkStructuralEquality(translationFilesContents, sourceLocale) {
     debug('Checking translation files:');
-    const enUSContent = translationFilesContents[sourceLocale];
-    if (!enUSContent) {
+    const sourceContent = translationFilesContents[sourceLocale];
+    if (!sourceContent) {
         throw new Error(`Missing source ${sourceLocale}.json file`);
     }
-    const enUSMessages = Object.entries(flatten(enUSContent)).reduce((all, [key, value]) => {
+    const sourceMessages = Object.entries(flatten(sourceContent)).reduce((all, [key, value]) => {
         try {
             all[key] = parse(value);
         }
@@ -42,17 +42,17 @@ export async function checkStructuralEquality(translationFilesContents, sourceLo
         .filter(([locale]) => locale !== sourceLocale)
         .reduce((result, [locale, content]) => {
         const localeMessages = flatten(content);
-        const problematicKeys = Object.keys(enUSMessages)
+        const problematicKeys = Object.keys(sourceMessages)
             .map(k => {
             if (!localeMessages[k]) {
                 return { key: k, success: true };
             }
-            const enUSMessage = enUSMessages[k];
+            const sourceMessage = sourceMessages[k];
             try {
                 const localeMessage = parse(localeMessages[k]);
                 return {
                     key: k,
-                    ...isStructurallySame(enUSMessage, localeMessage),
+                    ...isStructurallySame(sourceMessage, localeMessage),
                 };
             }
             catch (e) {

package/{lib_esnext/src → src}/verify/index.d.ts

@@ -1,7 +1,8 @@
 export interface VerifyOpts {
     sourceLocale: string;
     missingKeys: boolean;
+    extraKeys: boolean;
     structuralEquality: boolean;
     ignore?: string[];
 }
-export declare function verify(files: string[], { sourceLocale, missingKeys, structuralEquality }: VerifyOpts): Promise<void>;
+export declare function verify(files: string[], { sourceLocale, missingKeys, extraKeys, structuralEquality }: VerifyOpts): Promise<void>;

package/{lib_esnext/src → src}/verify/index.js

@@ -1,9 +1,10 @@
 import { basename } from 'path';
-import { debug } from '../console_utils';
-import { checkMissingKeys } from './checkMissingKeys';
+import { debug } from '../console_utils.js';
+import { checkMissingKeys } from './checkMissingKeys.js';
+import { checkExtraKeys } from './checkExtraKeys.js';
 import { readJSON } from 'fs-extra';
-import { checkStructuralEquality } from './checkStructuralEquality';
-export async function verify(files, { sourceLocale, missingKeys, structuralEquality }) {
+import { checkStructuralEquality } from './checkStructuralEquality.js';
+export async function verify(files, { sourceLocale, missingKeys, extraKeys, structuralEquality }) {
     debug('Checking translation files:');
     files.forEach(fn => debug(fn));
     const translationFilesContents = (await Promise.all(files.map(async (fn) => [basename(fn, '.json'), await readJSON(fn)]))).reduce((all, [locale, content]) => {
@@ -16,6 +17,10 @@ export async function verify(files, { sourceLocale, missingKeys, structuralEqual
         !(await checkMissingKeys(translationFilesContents, sourceLocale))) {
         exitCode = 1;
     }
+    if (extraKeys &&
+        !(await checkExtraKeys(translationFilesContents, sourceLocale))) {
+        exitCode = 1;
+    }
     if (structuralEquality &&
         !(await checkStructuralEquality(translationFilesContents, sourceLocale))) {
         exitCode = 1;

package/lib_esnext/main.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-require('./src/cli').default(process.argv);