@lingui/cli 3.17.1 → 4.0.0-next.0

package/build/lingui-extract.js

@@ -6,39 +6,35 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = command;
 var _chalk = _interopRequireDefault(require("chalk"));
 var _chokidar = _interopRequireDefault(require("chokidar"));
-var _commander = _interopRequireDefault(require("commander"));
+var _commander = require("commander");
+var _path = _interopRequireDefault(require("path"));
 var _conf = require("@lingui/conf");
-var _catalog = require("./api/catalog");
+var _api = require("./api");
 var _stats = require("./api/stats");
-var _detect = require("./api/detect");
 var _help = require("./api/help");
+var _ora = _interopRequireDefault(require("ora"));
+var _utils = require("./api/utils");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && 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);
+  options.verbose && console.log("Extracting messages from source files…");
+  const catalogs = (0, _api.getCatalogs)(config);
   const catalogStats = {};
   let commandSuccess = true;
+  const spinner = (0, _ora.default)().start();
   for (let catalog of catalogs) {
-    const catalogSuccess = await catalog.make({
+    const result = await catalog.make({
       ...options,
-      orderBy: config.orderBy,
-      extractors: config.extractors,
-      projectType: (0, _detect.detect)()
+      orderBy: config.orderBy
     });
-    catalogStats[catalog.path] = catalog.readAll();
-    commandSuccess && (commandSuccess = catalogSuccess);
+    catalogStats[(0, _utils.normalizeSlashes)(_path.default.relative(config.rootDir, catalog.path))] = result || {};
+    commandSuccess && (commandSuccess = Boolean(result));
+  }
+  if (commandSuccess) {
+    spinner.succeed();
+  } else {
+    spinner.fail();
   }
   Object.entries(catalogStats).forEach(([key, value]) => {
     console.log(`Catalog statistics for ${key}: `);
@@ -46,8 +42,8 @@ async function command(config, options) {
     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)`);
+    console.log(`(use "${_chalk.default.yellow((0, _help.helpRun)("extract"))}" to update catalogs with new messages)`);
+    console.log(`(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
@@ -58,26 +54,13 @@ async function command(config, options) {
   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);
+  _commander.program.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").parse(process.argv);
+  const options = _commander.program.opts();
   const config = (0, _conf.getConfig)({
-    configPath: _commander.default.config || process.env.LINGUI_CONFIG
+    configPath: options.config
   });
   let hasErrors = false;
-  if (_commander.default.format) {
-    hasErrors = true;
-    const msg = "--format option is deprecated." + " Please set format in configuration https://lingui.dev/ref/conf#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.dev/ref/conf#extractbabeloptions";
-    console.error(msg);
-    console.error();
-  }
-  const prevFormat = _commander.default.convertFrom;
+  const prevFormat = options.convertFrom;
   if (prevFormat && config.format === prevFormat) {
     hasErrors = true;
     console.error("Trying to migrate message catalog to the same format");
@@ -87,29 +70,33 @@ if (require.main === module) {
     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)) {
+  if (options.locale && !config.locales.includes(options.locale)) {
     hasErrors = true;
-    console.error(`Locale ${_chalk.default.bold(_commander.default.locale)} does not exist.`);
+    console.error(`Locale ${_chalk.default.bold(options.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,
+      verbose: options.watch || options.verbose || false,
+      clean: options.watch ? false : options.clean || false,
+      overwrite: options.watch || options.overwrite || false,
+      locale: options.locale,
+      watch: options.watch || false,
       files: filePath !== null && filePath !== void 0 && filePath.length ? filePath : undefined,
       prevFormat
     });
   };
   const changedPaths = new Set();
   let debounceTimer;
+  let previousExtract = Promise.resolve(true);
   const dispatchExtract = filePath => {
-    // Skip debouncing if not enabled
-    if (!_commander.default.debounce) return extract(filePath);
+    // Skip debouncing if not enabled but still chain them so no racing issue
+    // on deleting the tmp folder.
+    if (!options.debounce) {
+      previousExtract = previousExtract.then(() => extract(filePath));
+      return previousExtract;
+    }
     filePath === null || filePath === void 0 ? void 0 : filePath.forEach(path => changedPaths.add(path));
 
     // CLear the previous timer if there is any, and schedule the next
@@ -118,13 +105,13 @@ if (require.main === module) {
       const filePath = [...changedPaths];
       changedPaths.clear();
       await extract(filePath);
-    }, _commander.default.debounce);
+    }, options.debounce);
   };
 
   // Check if Watch Mode is enabled
-  if (_commander.default.watch) {
+  if (options.watch) {
     console.info(_chalk.default.bold("Initializing Watch Mode..."));
-    const catalogs = (0, _catalog.getCatalogs)(config);
+    const catalogs = (0, _api.getCatalogs)(config);
     let paths = [];
     let ignored = [];
     catalogs.forEach(catalog => {
@@ -140,10 +127,10 @@ if (require.main === module) {
       watcher.on("add", path => dispatchExtract([path])).on("change", path => dispatchExtract([path]));
     };
     watcher.on("ready", () => onReady());
-  } else if (_commander.default.args) {
+  } else if (_commander.program.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 => {
+    extract(_commander.program.args).then(result => {
       if (!result) process.exit(1);
     });
   } else {

package/build/lingui.js

@@ -1,13 +1,6 @@
 #!/usr/bin/env node
 "use strict";
 
-var _utils = require("./api/utils");
-const program = require("commander");
-let version;
-try {
-  version = require("./package.json").version;
-} catch (e) {
-  version = "dev";
-}
-program.version(version).command("add-locale", "Deprecated, run it for instructions").command("extract [files...]", "Extracts messages from source files").command("extract-template", "Extracts messages from source files to a .pot template").command("compile", "Compile message catalogs").parse(process.argv);
-(0, _utils.helpMisspelledCommand)(process.argv[2], program.commands);
+var _commander = require("commander");
+var _package = require("../package.json");
+_commander.program.version(_package.version).command("extract [files...]", "Extracts messages from source files").command("extract-template", "Extracts messages from source files to a .pot template").command("compile", "Compile message catalogs").parse(process.argv);

package/build/services/translationIO.js

@@ -19,6 +19,11 @@ const getCreateHeaders = language => ({
   "X-Generator": "@lingui/cli",
   Language: language
 });
+const getTargetLocales = config => {
+  const sourceLocale = config.sourceLocale || "en";
+  const pseudoLocale = config.pseudoLocale || "pseudo";
+  return config.locales.filter(value => value != sourceLocale && value != pseudoLocale);
+};
 
 // Main sync method, call "Init" or "Sync" depending on the project context
 function syncProcess(config, options) {
@@ -45,8 +50,7 @@ function syncProcess(config, options) {
 // Cf. https://translation.io/docs/create-library#initialization
 function init(config, options, successCallback, failCallback) {
   const sourceLocale = config.sourceLocale || "en";
-  const pseudoLocale = config.pseudoLocale || "pseudo";
-  const targetLocales = config.locales.filter(value => value != sourceLocale && value != pseudoLocale);
+  const targetLocales = getTargetLocales(config);
   const paths = poPathsPerLocale(config);
   let segments = {};
   targetLocales.forEach(targetLocale => {
@@ -98,7 +102,7 @@ function init(config, options, successCallback, failCallback) {
 // Cf. https://translation.io/docs/create-library#synchronization
 function sync(config, options, successCallback, failCallback) {
   const sourceLocale = config.sourceLocale || "en";
-  const targetLocales = config.locales.filter(value => value != sourceLocale);
+  const targetLocales = getTargetLocales(config);
   const paths = poPathsPerLocale(config);
   let segments = [];
 

package/build/tests.js

@@ -4,19 +4,29 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.copyFixture = copyFixture;
-exports.makeCatalog = exports.defaultMergeOptions = exports.defaultMakeTemplateOptions = exports.defaultMakeOptions = void 0;
+exports.defaultMergeOptions = exports.defaultMakeTemplateOptions = exports.defaultMakeOptions = void 0;
+exports.listingToHumanReadable = listingToHumanReadable;
+exports.makeCatalog = void 0;
 exports.makeNextMessage = makeNextMessage;
 exports.makePrevMessage = makePrevMessage;
+exports.normalizeLineEndings = void 0;
+exports.readFsToJson = readFsToJson;
 var _os = _interopRequireDefault(require("os"));
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
 var _path = _interopRequireDefault(require("path"));
-var _jestMocks = require("@lingui/jest-mocks");
+var _fs = _interopRequireDefault(require("fs"));
 var _catalog = require("./api/catalog");
+var _conf = require("@lingui/conf");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function copyFixture(fixtureDir) {
-  const tmpDir = _fsExtra.default.mkdtempSync(_path.default.join(_os.default.tmpdir(), `lingui-test-${process.pid}`));
-  if (_fsExtra.default.existsSync(fixtureDir)) {
-    _fsExtra.default.copySync(fixtureDir, tmpDir);
+async function copyFixture(fixtureDir) {
+  const tmpDir = await _fs.default.promises.mkdtemp(_path.default.join(_os.default.tmpdir(), `lingui-test-${process.pid}`));
+  try {
+    await _fs.default.promises.cp(fixtureDir, tmpDir, {
+      recursive: true
+    });
+  } catch (err) {
+    if (err.code != "ENOENT") {
+      throw err;
+    }
   }
   return tmpDir;
 }
@@ -26,27 +36,32 @@ const defaultMakeOptions = {
   overwrite: false,
   locale: null,
   prevFormat: null,
-  configPath: null,
   orderBy: "messageId"
 };
 exports.defaultMakeOptions = defaultMakeOptions;
 const defaultMakeTemplateOptions = {
   verbose: false,
-  configPath: null,
   orderBy: "messageId"
 };
 exports.defaultMakeTemplateOptions = defaultMakeTemplateOptions;
 const defaultMergeOptions = {
   overwrite: false
 };
+
+// on windows line endings are different,
+// so direct comparison to snapshot would file if not normalized
 exports.defaultMergeOptions = defaultMergeOptions;
+const normalizeLineEndings = str => str.replace(/\r?\n/g, "\r\n");
+exports.normalizeLineEndings = normalizeLineEndings;
 const makeCatalog = (config = {}) => {
   return new _catalog.Catalog({
     name: "messages",
     path: "{locale}/messages",
     include: [],
     exclude: []
-  }, (0, _jestMocks.mockConfig)(config));
+  }, (0, _conf.makeConfig)(config, {
+    skipValidation: true
+  }));
 };
 exports.makeCatalog = makeCatalog;
 function makePrevMessage(message = {}) {
@@ -61,4 +76,34 @@ function makeNextMessage(message = {}) {
     obsolete: false,
     ...message
   };
+}
+function listingToHumanReadable(listing) {
+  const output = [];
+  Object.entries(listing).forEach(([filename, value]) => {
+    if (typeof value === "string") {
+      output.push("#######################");
+      output.push(`Filename: ${filename}`);
+      output.push("#######################");
+      output.push("");
+      output.push(normalizeLineEndings(value));
+      output.push("");
+    } else {
+      output.push(...listingToHumanReadable(value));
+    }
+  });
+  return output.join("\n");
+}
+function readFsToJson(directory, filter) {
+  const out = {};
+  _fs.default.readdirSync(directory).map(filename => {
+    const filepath = _path.default.join(directory, filename);
+    if (_fs.default.lstatSync(filepath).isDirectory()) {
+      out[filename] = readFsToJson(filepath);
+      return out;
+    }
+    if (!filter || filter(filename)) {
+      out[filename] = _fs.default.readFileSync(filepath).toString();
+    }
+  });
+  return out;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/cli",
-  "version": "3.17.1",
+  "version": "4.0.0-next.0",
   "description": "CLI for working wit message catalogs",
   "keywords": [
     "cli",
@@ -37,7 +37,7 @@
     }
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0"
   },
   "files": [
     "LICENSE",
@@ -45,24 +45,24 @@
     "build/"
   ],
   "dependencies": {
+    "@babel/core": "^7.20.12",
     "@babel/generator": "^7.20.14",
     "@babel/parser": "^7.20.15",
     "@babel/plugin-syntax-jsx": "^7.18.6",
     "@babel/runtime": "^7.20.13",
     "@babel/types": "^7.20.7",
-    "@lingui/babel-plugin-extract-messages": "3.17.1",
-    "@lingui/conf": "3.17.1",
-    "@lingui/core": "3.17.1",
+    "@lingui/babel-plugin-extract-messages": "^4.0.0-next.0",
+    "@lingui/conf": "^4.0.0-next.0",
+    "@lingui/core": "^4.0.0-next.0",
     "@messageformat/parser": "^5.0.0",
     "babel-plugin-macros": "^3.0.1",
     "bcp-47": "^1.0.7",
     "chalk": "^4.1.0",
     "chokidar": "3.5.1",
     "cli-table": "0.3.6",
-    "commander": "^6.1.0",
+    "commander": "^10.0.0",
+    "convert-source-map": "^2.0.0",
     "date-fns": "^2.16.1",
-    "fs-extra": "^9.0.1",
-    "fuzzaldrin": "^2.1.0",
     "glob": "^7.1.4",
     "inquirer": "^7.3.3",
     "make-plural": "^6.2.2",
@@ -72,24 +72,21 @@
     "normalize-path": "^3.0.0",
     "ora": "^5.1.0",
     "papaparse": "^5.3.0",
-    "pkg-up": "^3.1.0",
     "plurals-cldr": "^1.0.4",
-    "pofile": "^1.1.0",
+    "pofile": "^1.1.4",
     "pseudolocale": "^1.1.0",
-    "ramda": "^0.27.1"
+    "ramda": "^0.27.1",
+    "source-map": "^0.8.0-beta.0"
   },
   "devDependencies": {
+    "@lingui/jest-mocks": "^3.0.3",
+    "@types/convert-source-map": "^2.0.0",
     "@types/micromatch": "^4.0.1",
     "@types/normalize-path": "^3.0.0",
     "@types/papaparse": "^5.2.3",
     "@types/plurals-cldr": "^1.0.1",
-    "mockdate": "^3.0.2",
-    "typescript": "^4.9.5"
+    "mock-fs": "^5.2.0",
+    "mockdate": "^3.0.2"
   },
-  "peerDependencies": {
-    "@babel/core": "^7.0.0",
-    "babel-plugin-macros": "2 || 3",
-    "typescript": "2 || 3 || 4"
-  },
-  "gitHead": "76ef4e8d1c668578ce2c3829ebf35d22ca5e679c"
+  "gitHead": "637f5cf6beda9d4ebce4e15cd9fdaa23e404b660"
 }