@lingui/cli 3.15.0 → 3.16.0

package/{api → build/api}/utils.js

@@ -1,7 +1,5 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -21,16 +19,17 @@ var _chalk = _interopRequireDefault(require("chalk"));
 
 var _fuzzaldrin = require("fuzzaldrin");
 
-function removeDirectory(dir) {
-  var onlyContent = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function removeDirectory(dir, onlyContent = false) {
   if (!_fs.default.existsSync(dir)) return;
 
-  var list = _fs.default.readdirSync(dir);
+  const list = _fs.default.readdirSync(dir);
 
-  for (var i = 0; i < list.length; i++) {
-    var filename = _path.default.join(dir, list[i]);
+  for (let i = 0; i < list.length; i++) {
+    const filename = _path.default.join(dir, list[i]);
 
-    var stat = _fs.default.statSync(filename);
+    const stat = _fs.default.statSync(filename);
 
     if (filename === "." || filename === "..") {// pass these files
     } else if (stat.isDirectory()) {
@@ -48,9 +47,7 @@ function removeDirectory(dir) {
 
 function prettyOrigin(origins) {
   try {
-    return origins.map(function (origin) {
-      return origin.join(":");
-    }).join(", ");
+    return origins.map(origin => origin.join(":")).join(", ");
   } catch (e) {
     return "";
   }
@@ -65,49 +62,36 @@ function prettyOrigin(origins) {
  */
 
 
-function helpMisspelledCommand(command) {
-  var availableCommands = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-  var commandNames = availableCommands.map(function (command) {
-    return command.name();
-  }); // if no command is supplied, then commander.js shows help automatically
+function helpMisspelledCommand(command, availableCommands = []) {
+  const commandNames = availableCommands.map(command => command.name()); // if no command is supplied, then commander.js shows help automatically
 
   if (!command || commandNames.includes(command)) {
     return;
   }
 
-  var suggestions = commandNames.map(function (name) {
-    return {
-      name: name,
-      score: (0, _fuzzaldrin.score)(name, command.slice(0, name.length))
-    };
-  }).filter(function (nameScore) {
-    return nameScore.score > 0;
-  }).slice(0, 3).map(function (commandScore) {
-    return _chalk.default.inverse(commandScore.name);
-  }).join(", ");
-  console.log("lingui: command ".concat(command, " is not a lingui command. ") + "See 'lingui --help' for the list of available commands.");
+  const suggestions = commandNames.map(name => ({
+    name,
+    score: (0, _fuzzaldrin.score)(name, command.slice(0, name.length))
+  })).filter(nameScore => nameScore.score > 0).slice(0, 3).map(commandScore => _chalk.default.inverse(commandScore.name)).join(", ");
+  console.log(`lingui: command ${command} is not a lingui command. ` + `See 'lingui --help' for the list of available commands.`);
 
   if (suggestions) {
     console.log();
-    console.log("Did you mean: ".concat(suggestions, "?"));
+    console.log(`Did you mean: ${suggestions}?`);
   }
 }
 
-var splitOrigin = function splitOrigin(origin) {
-  return origin.split(":");
-};
+const splitOrigin = origin => origin.split(":");
 
 exports.splitOrigin = splitOrigin;
 
-var joinOrigin = function joinOrigin(origin) {
-  return origin.join(":");
-};
+const joinOrigin = origin => origin.join(":");
 
 exports.joinOrigin = joinOrigin;
 
 function writeFileIfChanged(filename, newContent) {
   if (_fs.default.existsSync(filename)) {
-    var raw = _fs.default.readFileSync(filename).toString();
+    const raw = _fs.default.readFileSync(filename).toString();
 
     if (newContent !== raw) {
       _fs.default.writeFileSync(filename, newContent);
@@ -122,9 +106,6 @@ function hasYarn() {
 }
 
 function makeInstall() {
-  var withYarn = hasYarn();
-  return function (packageName) {
-    var dev = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-    return withYarn ? "yarn add ".concat(dev ? "--dev " : "").concat(packageName) : "npm install ".concat(dev ? "--save-dev" : "--save", " ").concat(packageName);
-  };
+  const withYarn = hasYarn();
+  return (packageName, dev = false) => withYarn ? `yarn add ${dev ? "--dev " : ""}${packageName}` : `npm install ${dev ? "--save-dev" : "--save"} ${packageName}`;
 }

package/build/lingui-add-locale.js

@@ -0,0 +1,11 @@
+"use strict";
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+if (require.main === module) {
+  const msg = "lingui add-locale command is deprecated. " + `Please set ${_chalk.default.yellow("'locales'")} in configuration. ` + _chalk.default.underline("https://lingui.js.org/ref/conf.html#locales");
+
+  console.error(msg);
+}

package/build/lingui-compile.js

@@ -0,0 +1,192 @@
+"use strict";
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _chokidar = _interopRequireDefault(require("chokidar"));
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var R = _interopRequireWildcard(require("ramda"));
+
+var _commander = _interopRequireDefault(require("commander"));
+
+var plurals = _interopRequireWildcard(require("make-plural"));
+
+var _conf = require("@lingui/conf");
+
+var _catalog = require("./api/catalog");
+
+var _compile = require("./api/compile");
+
+var _help = require("./api/help");
+
+var _api = require("./api");
+
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
+
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const noMessages = R.pipe(R.map(R.isEmpty), R.values, R.all(R.equals(true)));
+
+function command(config, options) {
+  const catalogs = (0, _catalog.getCatalogs)(config);
+
+  if (noMessages(catalogs)) {
+    console.error("Nothing to compile, message catalogs are empty!\n");
+    console.error(`(use "${_chalk.default.yellow((0, _help.helpRun)("extract"))}" to extract messages from source files)`);
+    return false;
+  } // Check config.compile.merge if catalogs for current locale are to be merged into a single compiled file
+
+
+  const doMerge = !!config.catalogsMergePath;
+  let mergedCatalogs = {};
+  console.error("Compiling message catalogs…");
+  config.locales.forEach(locale => {
+    const [language] = locale.split(/[_-]/);
+
+    if (locale !== config.pseudoLocale && !plurals[language]) {
+      console.log(_chalk.default.red(`Error: Invalid locale ${_chalk.default.bold(locale)} (missing plural rules)!`));
+      console.error();
+    }
+
+    catalogs.forEach(catalog => {
+      const messages = catalog.getTranslations(locale, {
+        fallbackLocales: config.fallbackLocales,
+        sourceLocale: config.sourceLocale
+      });
+
+      if (!options.allowEmpty) {
+        const missingMsgIds = R.pipe(R.pickBy(R.isNil), R.keys)(messages);
+
+        if (missingMsgIds.length > 0) {
+          console.error(_chalk.default.red(`Error: Failed to compile catalog for locale ${_chalk.default.bold(locale)}!`));
+
+          if (options.verbose) {
+            console.error(_chalk.default.red("Missing translations:"));
+            missingMsgIds.forEach(msgId => console.log(msgId));
+          } else {
+            console.error(_chalk.default.red(`Missing ${missingMsgIds.length} translation(s)`));
+          }
+
+          console.error();
+          process.exit(1);
+        }
+      }
+
+      if (doMerge) {
+        mergedCatalogs = { ...mergedCatalogs,
+          ...messages
+        };
+      } else {
+        const namespace = options.typescript ? "ts" : options.namespace || config.compileNamespace;
+        const compiledCatalog = (0, _compile.createCompiledCatalog)(locale, messages, {
+          strict: false,
+          namespace,
+          pseudoLocale: config.pseudoLocale,
+          compilerBabelOptions: config.compilerBabelOptions
+        });
+        const compiledPath = catalog.writeCompiled(locale, compiledCatalog, namespace);
+
+        if (options.typescript) {
+          const typescriptPath = compiledPath.replace(/\.ts?$/, "") + ".d.ts";
+
+          _fs.default.writeFileSync(typescriptPath, `import { Messages } from '@lingui/core';
+          declare const messages: Messages;
+          export { messages };
+          `);
+        }
+
+        options.verbose && console.error(_chalk.default.green(`${locale} ⇒ ${compiledPath}`));
+      }
+    });
+
+    if (doMerge) {
+      const compileCatalog = (0, _catalog.getCatalogForMerge)(config);
+      const namespace = options.namespace || config.compileNamespace;
+      const compiledCatalog = (0, _compile.createCompiledCatalog)(locale, mergedCatalogs, {
+        strict: false,
+        namespace: namespace,
+        pseudoLocale: config.pseudoLocale,
+        compilerBabelOptions: config.compilerBabelOptions
+      });
+      const compiledPath = compileCatalog.writeCompiled(locale, compiledCatalog, namespace);
+      options.verbose && console.log(_chalk.default.green(`${locale} ⇒ ${compiledPath}`));
+    }
+  });
+  return true;
+}
+
+if (require.main === module) {
+  _commander.default.description("Add compile message catalogs and add language data (plurals) to compiled bundle.").option("--config <path>", "Path to the config file").option("--strict", "Disable defaults for missing translations").option("--verbose", "Verbose output").option("--format <format>", "Format of message catalog").option("--typescript", "Create Typescript definition for compiled bundle").option("--namespace <namespace>", "Specify namespace for compiled bundle. Ex: cjs(default) -> module.exports, es -> export, window.test -> window.test").option("--watch", "Enables Watch Mode").option("--debounce <delay>", "Debounces compilation for given amount of milliseconds").on("--help", function () {
+    console.log("\n  Examples:\n");
+    console.log("    # Compile translations and use defaults or message IDs for missing translations");
+    console.log(`    $ ${(0, _help.helpRun)("compile")}`);
+    console.log("");
+    console.log("    # Compile translations but fail when there are missing");
+    console.log("    # translations (don't replace missing translations with");
+    console.log("    # default messages or message IDs)");
+    console.log(`    $ ${(0, _help.helpRun)("compile --strict")}`);
+  }).parse(process.argv);
+
+  const config = (0, _conf.getConfig)({
+    configPath: _commander.default.config
+  });
+
+  if (_commander.default.format) {
+    const msg = "--format option is deprecated and will be removed in @lingui/cli@3.0.0." + " Please set format in configuration https://lingui.js.org/ref/conf.html#format";
+    console.warn(msg);
+    config.format = _commander.default.format;
+  }
+
+  const compile = () => command(config, {
+    verbose: _commander.default.watch || _commander.default.verbose || false,
+    allowEmpty: !_commander.default.strict,
+    typescript: _commander.default.typescript || config.compileNamespace === "ts" || false,
+    namespace: _commander.default.namespace // we want this to be undefined if user does not specify so default can be used
+
+  });
+
+  let debounceTimer;
+
+  const dispatchCompile = () => {
+    // Skip debouncing if not enabled
+    if (!_commander.default.debounce) return compile(); // CLear the previous timer if there is any, and schedule the next
+
+    debounceTimer && clearTimeout(debounceTimer);
+    debounceTimer = setTimeout(() => compile(), _commander.default.debounce);
+  }; // Check if Watch Mode is enabled
+
+
+  if (_commander.default.watch) {
+    console.info(_chalk.default.bold("Initializing Watch Mode..."));
+    const catalogs = (0, _catalog.getCatalogs)(config);
+    let paths = [];
+    const catalogExtension = (0, _api.getFormat)(config.format).catalogExtension;
+    config.locales.forEach(locale => {
+      catalogs.forEach(catalog => {
+        paths.push(`${catalog.path.replace(/{locale}/g, locale).replace(/{name}/g, "*")}${catalogExtension}`);
+      });
+    });
+
+    const watcher = _chokidar.default.watch(paths, {
+      persistent: true
+    });
+
+    const onReady = () => {
+      console.info(_chalk.default.green.bold("Watcher is ready!"));
+      watcher.on("add", () => dispatchCompile()).on("change", () => dispatchCompile());
+    };
+
+    watcher.on("ready", () => onReady());
+  } else {
+    const results = compile();
+
+    if (!results) {
+      process.exit(1);
+    }
+
+    console.log("Done!");
+  }
+}

package/build/lingui-extract-template.js

@@ -0,0 +1,64 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = command;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _commander = _interopRequireDefault(require("commander"));
+
+var _conf = require("@lingui/conf");
+
+var _catalog = require("./api/catalog");
+
+var _detect = require("./api/detect");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+async function command(config, options) {
+  // `react-app` babel plugin used by CRA requires either BABEL_ENV or NODE_ENV to be
+  // set. We're setting it here, because lingui macros are going to use them as well.
+  if (!process.env.BABEL_ENV && !process.env.NODE_ENV) {
+    process.env.BABEL_ENV = "development";
+  } // We need macros to keep imports, so extract-messages plugin know what componets
+  // to collect. Users usually use both BABEN_ENV and NODE_ENV, so it's probably
+  // safer to introduce a new env variable. LINGUI_EXTRACT=1 during `lingui extract`
+
+
+  process.env.LINGUI_EXTRACT = "1";
+  options.verbose && console.error("Extracting messages from source files…");
+  const catalogs = (0, _catalog.getCatalogs)(config);
+  const catalogStats = {};
+  await Promise.all(catalogs.map(async catalog => {
+    await catalog.makeTemplate({ ...options,
+      orderBy: config.orderBy,
+      projectType: (0, _detect.detect)()
+    });
+    const catalogTemplate = catalog.readTemplate();
+
+    if (catalogTemplate !== null && catalogTemplate !== undefined) {
+      catalogStats[catalog.templateFile] = Object.keys(catalogTemplate).length;
+    }
+  }));
+  Object.entries(catalogStats).forEach(([key, value]) => {
+    console.log(`Catalog statistics for ${_chalk.default.bold(key)}: ${_chalk.default.green(value)} messages`);
+    console.log();
+  });
+  return true;
+}
+
+if (require.main === module) {
+  _commander.default.option("--config <path>", "Path to the config file").option("--verbose", "Verbose output").parse(process.argv);
+
+  const config = (0, _conf.getConfig)({
+    configPath: _commander.default.config || process.env.LINGUI_CONFIG
+  });
+  const result = command(config, {
+    verbose: _commander.default.verbose || false,
+    configPath: _commander.default.config || process.env.LINGUI_CONFIG
+  }).then(() => {
+    if (!result) process.exit(1);
+  });
+}

package/build/lingui-extract.js

@@ -0,0 +1,181 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = command;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _chokidar = _interopRequireDefault(require("chokidar"));
+
+var _commander = _interopRequireDefault(require("commander"));
+
+var _conf = require("@lingui/conf");
+
+var _catalog = require("./api/catalog");
+
+var _stats = require("./api/stats");
+
+var _detect = require("./api/detect");
+
+var _help = require("./api/help");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
+
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+async function command(config, options) {
+  // `react-app` babel plugin used by CRA requires either BABEL_ENV or NODE_ENV to be
+  // set. We're setting it here, because lingui macros are going to use them as well.
+  if (!process.env.BABEL_ENV && !process.env.NODE_ENV) {
+    process.env.BABEL_ENV = "development";
+  } // We need macros to keep imports, so extract-messages plugin know what componets
+  // to collect. Users usually use both BABEN_ENV and NODE_ENV, so it's probably
+  // safer to introduce a new env variable. LINGUI_EXTRACT=1 during `lingui extract`
+
+
+  process.env.LINGUI_EXTRACT = "1";
+  options.verbose && console.error("Extracting messages from source files…");
+  const catalogs = (0, _catalog.getCatalogs)(config);
+  const catalogStats = {};
+  let commandSuccess = true;
+
+  for (let catalog of catalogs) {
+    const catalogSuccess = await catalog.make({ ...options,
+      orderBy: config.orderBy,
+      extractors: config.extractors,
+      projectType: (0, _detect.detect)()
+    });
+    catalogStats[catalog.path] = catalog.readAll();
+    commandSuccess && (commandSuccess = catalogSuccess);
+  }
+
+  Object.entries(catalogStats).forEach(([key, value]) => {
+    console.log(`Catalog statistics for ${key}: `);
+    console.log((0, _stats.printStats)(config, value).toString());
+    console.log();
+  });
+
+  if (!options.watch) {
+    console.error(`(use "${_chalk.default.yellow((0, _help.helpRun)("extract"))}" to update catalogs with new messages)`);
+    console.error(`(use "${_chalk.default.yellow((0, _help.helpRun)("compile"))}" to compile catalogs for production)`);
+  } // If service key is present in configuration, synchronize with cloud translation platform
+
+
+  if (typeof config.service === 'object' && config.service.name && config.service.name.length) {
+    const moduleName = config.service.name.charAt(0).toLowerCase() + config.service.name.slice(1);
+    Promise.resolve(`./services/${moduleName}`).then(s => _interopRequireWildcard(require(s))).then(module => module.default(config, options)).catch(err => console.error(`Can't load service module ${moduleName}`, err));
+  }
+
+  return commandSuccess;
+}
+
+if (require.main === module) {
+  _commander.default.option("--config <path>", "Path to the config file").option("--locale <locale>", "Only extract the specified locale").option("--overwrite", "Overwrite translations for source locale").option("--clean", "Remove obsolete translations").option("--debounce <delay>", "Debounces extraction for given amount of milliseconds").option("--verbose", "Verbose output").option("--convert-from <format>", "Convert from previous format of message catalogs").option("--watch", "Enables Watch Mode") // Obsolete options
+  .option("--babelOptions", "Babel options passed to transform/extract plugins").option("--format <format>", "Format of message catalogs").parse(process.argv);
+
+  const config = (0, _conf.getConfig)({
+    configPath: _commander.default.config || process.env.LINGUI_CONFIG
+  });
+  let hasErrors = false;
+
+  if (_commander.default.format) {
+    hasErrors = true;
+    const msg = "--format option is deprecated." + " Please set format in configuration https://lingui.js.org/ref/conf.html#format";
+    console.error(msg);
+    console.error();
+  }
+
+  if (_commander.default.babelOptions) {
+    hasErrors = true;
+    const msg = "--babelOptions option is deprecated." + " Please set extractBabelOptions in configuration https://lingui.js.org/ref/conf.html#extractBabelOptions";
+    console.error(msg);
+    console.error();
+  }
+
+  const prevFormat = _commander.default.convertFrom;
+
+  if (prevFormat && config.format === prevFormat) {
+    hasErrors = true;
+    console.error("Trying to migrate message catalog to the same format");
+    console.error(`Set ${_chalk.default.bold("new")} format in LinguiJS configuration\n` + ` and ${_chalk.default.bold("previous")} format using --convert-from option.`);
+    console.log();
+    console.log(`Example: Convert from lingui format to minimal`);
+    console.log(_chalk.default.yellow((0, _help.helpRun)(`extract --convert-from lingui`)));
+    process.exit(1);
+  }
+
+  if (_commander.default.locale && !config.locales.includes(_commander.default.locale)) {
+    hasErrors = true;
+    console.error(`Locale ${_chalk.default.bold(_commander.default.locale)} does not exist.`);
+    console.error();
+  }
+
+  if (hasErrors) process.exit(1);
+
+  const extract = filePath => {
+    return command(config, {
+      verbose: _commander.default.watch || _commander.default.verbose || false,
+      clean: _commander.default.watch ? false : _commander.default.clean || false,
+      overwrite: _commander.default.watch || _commander.default.overwrite || false,
+      locale: _commander.default.locale,
+      configPath: _commander.default.config || process.env.LINGUI_CONFIG,
+      watch: _commander.default.watch || false,
+      files: filePath?.length ? filePath : undefined,
+      prevFormat
+    });
+  };
+
+  const changedPaths = new Set();
+  let debounceTimer;
+
+  const dispatchExtract = filePath => {
+    // Skip debouncing if not enabled
+    if (!_commander.default.debounce) return extract(filePath);
+    filePath?.forEach(path => changedPaths.add(path)); // CLear the previous timer if there is any, and schedule the next
+
+    debounceTimer && clearTimeout(debounceTimer);
+    debounceTimer = setTimeout(async () => {
+      const filePath = [...changedPaths];
+      changedPaths.clear();
+      await extract(filePath);
+    }, _commander.default.debounce);
+  }; // Check if Watch Mode is enabled
+
+
+  if (_commander.default.watch) {
+    console.info(_chalk.default.bold("Initializing Watch Mode..."));
+    const catalogs = (0, _catalog.getCatalogs)(config);
+    let paths = [];
+    let ignored = [];
+    catalogs.forEach(catalog => {
+      paths.push(...catalog.include);
+      ignored.push(...catalog.exclude);
+    });
+
+    const watcher = _chokidar.default.watch(paths, {
+      ignored: ["/(^|[/\\])../", ...ignored],
+      persistent: true
+    });
+
+    const onReady = () => {
+      console.info(_chalk.default.green.bold("Watcher is ready!"));
+      watcher.on("add", path => dispatchExtract([path])).on("change", path => dispatchExtract([path]));
+    };
+
+    watcher.on("ready", () => onReady());
+  } else if (_commander.default.args) {
+    // this behaviour occurs when we extract files by his name
+    // for ex: lingui extract src/app, this will extract only files included in src/app
+    extract(_commander.default.args).then(result => {
+      if (!result) process.exit(1);
+    });
+  } else {
+    extract().then(result => {
+      if (!result) process.exit(1);
+    });
+  }
+}

package/{lingui.js → build/lingui.js}

@@ -3,9 +3,9 @@
 
 var _utils = require("./api/utils");
 
-var program = require("commander");
+const program = require("commander");
 
-var version;
+let version;
 
 try {
   version = require("./package.json").version;