@lingui/cli 4.0.0-next.0 → 4.0.0-next.2

package/build/lingui-compile.js

@@ -8,16 +8,15 @@ var _chalk = _interopRequireDefault(require("chalk"));
 var _chokidar = _interopRequireDefault(require("chokidar"));
 var _fs = _interopRequireDefault(require("fs"));
 var _commander = require("commander");
-var plurals = _interopRequireWildcard(require("make-plural"));
 var _conf = require("@lingui/conf");
 var _compile = require("./api/compile");
 var _help = require("./api/help");
 var _api = require("./api");
 var _getCatalogs = require("./api/catalog/getCatalogs");
-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; }
+var _utils = require("./api/utils");
+var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function command(config, options) {
+async function command(config, options) {
   const catalogs = (0, _api.getCatalogs)(config);
 
   // Check config.compile.merge if catalogs for current locale are to be merged into a single compiled file
@@ -25,16 +24,9 @@ function command(config, options) {
   let mergedCatalogs = {};
   console.log("Compiling message catalogs…");
   for (const locale of config.locales) {
-    const [language] = locale.split(/[_-]/);
-    // todo: this validation should be in @lingui/conf
-    // todo: validate locales according bcp47, instead of plurals
-    if (locale !== config.pseudoLocale && !plurals[language]) {
-      console.error(_chalk.default.red(`Error: Invalid locale ${_chalk.default.bold(locale)} (missing plural rules)!`));
-      console.error();
-    }
     for (const catalog of catalogs) {
       const missingMessages = [];
-      const messages = catalog.getTranslations(locale, {
+      const messages = await catalog.getTranslations(locale, {
         fallbackLocales: config.fallbackLocales,
         sourceLocale: config.sourceLocale,
         onMissing: missing => {
@@ -68,7 +60,7 @@ function command(config, options) {
           pseudoLocale: config.pseudoLocale,
           compilerBabelOptions: config.compilerBabelOptions
         });
-        const compiledPath = catalog.writeCompiled(locale, compiledCatalog, namespace);
+        let compiledPath = await catalog.writeCompiled(locale, compiledCatalog, namespace);
         if (options.typescript) {
           const typescriptPath = compiledPath.replace(/\.ts?$/, "") + ".d.ts";
           _fs.default.writeFileSync(typescriptPath, `import { Messages } from '@lingui/core';
@@ -76,6 +68,7 @@ function command(config, options) {
           export { messages };
           `);
         }
+        compiledPath = (0, _utils.normalizeSlashes)(_path.default.relative(config.rootDir, compiledPath));
         options.verbose && console.error(_chalk.default.green(`${locale} ⇒ ${compiledPath}`));
       }
     }
@@ -88,7 +81,8 @@ function command(config, options) {
         pseudoLocale: config.pseudoLocale,
         compilerBabelOptions: config.compilerBabelOptions
       });
-      const compiledPath = compileCatalog.writeCompiled(locale, compiledCatalog, namespace);
+      let compiledPath = await compileCatalog.writeCompiled(locale, compiledCatalog, namespace);
+      compiledPath = (0, _utils.normalizeSlashes)(_path.default.relative(config.rootDir, compiledPath));
       options.verbose && console.log(_chalk.default.green(`${locale} ⇒ ${compiledPath}`));
     }
   }
@@ -109,17 +103,21 @@ if (require.main === module) {
   const config = (0, _conf.getConfig)({
     configPath: options.config
   });
-  const compile = () => command(config, {
-    verbose: options.watch || options.verbose || false,
-    allowEmpty: !options.strict,
-    typescript: options.typescript || config.compileNamespace === "ts" || false,
-    namespace: options.namespace // we want this to be undefined if user does not specify so default can be used
-  });
+  let previousRun = Promise.resolve(true);
+  const compile = () => {
+    previousRun = previousRun.then(() => command(config, {
+      verbose: options.watch || options.verbose || false,
+      allowEmpty: !options.strict,
+      typescript: options.typescript || config.compileNamespace === "ts" || false,
+      namespace: options.namespace // we want this to be undefined if user does not specify so default can be used
+    }));
 
+    return previousRun;
+  };
   let debounceTimer;
   const dispatchCompile = () => {
     // Skip debouncing if not enabled
-    if (!options.debounce) return compile();
+    if (!options.debounce) compile();
 
     // CLear the previous timer if there is any, and schedule the next
     debounceTimer && clearTimeout(debounceTimer);
@@ -131,7 +129,7 @@ if (require.main === module) {
     console.info(_chalk.default.bold("Initializing Watch Mode..."));
     const catalogs = (0, _api.getCatalogs)(config);
     let paths = [];
-    const catalogExtension = (0, _api.getFormat)(config.format).catalogExtension;
+    const catalogExtension = (0, _api.getFormat)(config.format, config.formatOptions).getCatalogExtension();
     config.locales.forEach(locale => {
       catalogs.forEach(catalog => {
         paths.push(`${catalog.path.replace(/{locale}/g, locale).replace(/{name}/g, "*")}${catalogExtension}`);
@@ -146,10 +144,11 @@ if (require.main === module) {
     };
     watcher.on("ready", () => onReady());
   } else {
-    const results = compile();
-    if (!results) {
-      process.exit(1);
-    }
-    console.log("Done!");
+    compile().then(results => {
+      if (!results) {
+        process.exit(1);
+      }
+      console.log("Done!");
+    });
   }
 }

package/build/lingui-extract-experimental.js

@@ -0,0 +1,103 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = command;
+var _commander = require("commander");
+var _conf = require("@lingui/conf");
+var _path = _interopRequireDefault(require("path"));
+var _os = _interopRequireDefault(require("os"));
+var _formats = require("./api/formats");
+var _promises = _interopRequireDefault(require("fs/promises"));
+var _extractFromFiles = require("./api/catalog/extractFromFiles");
+var _utils = require("./api/utils");
+var _bundleSource = require("./extract-experimental/bundleSource");
+var _writeCatalogs = require("./extract-experimental/writeCatalogs");
+var _getEntryPoints = require("./extract-experimental/getEntryPoints");
+var _chalk = _interopRequireDefault(require("chalk"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+async function command(linguiConfig, options) {
+  var _linguiConfig$experim;
+  options.verbose && console.log("Extracting messages from source files…");
+  const config = (_linguiConfig$experim = linguiConfig.experimental) === null || _linguiConfig$experim === void 0 ? void 0 : _linguiConfig$experim.extractor;
+  if (!config) {
+    throw new Error("The configuration for experimental extractor is empty. Please read the docs.");
+  }
+  console.log(_chalk.default.yellow(["You have using an experimental feature", "Experimental features are not covered by semver, and may cause unexpected or broken application behavior." + " Use at your own risk.", ""].join("\n")));
+  const tempDir = await _promises.default.mkdtemp(_path.default.join(_os.default.tmpdir(), "js-lingui-extract-"));
+  await _promises.default.rm(tempDir, {
+    recursive: true,
+    force: true
+  });
+  const bundleResult = await (0, _bundleSource.bundleSource)(config, (0, _getEntryPoints.getEntryPoints)(config.entries), tempDir, linguiConfig.rootDir);
+  const stats = [];
+  let commandSuccess = true;
+  const format = (0, _formats.getFormat)(linguiConfig.format, linguiConfig.formatOptions);
+  for (const outFile of Object.keys(bundleResult.metafile.outputs)) {
+    const messages = await (0, _extractFromFiles.extractFromFiles)([outFile], linguiConfig);
+    const {
+      entryPoint
+    } = bundleResult.metafile.outputs[outFile];
+    let output;
+    if (!messages) {
+      commandSuccess = false;
+      continue;
+    }
+    if (options.template) {
+      output = (await (0, _writeCatalogs.writeTemplate)({
+        linguiConfig,
+        clean: options.clean,
+        format,
+        messages,
+        entryPoint,
+        outputPattern: config.output
+      })).statMessage;
+    } else {
+      output = (await (0, _writeCatalogs.writeCatalogs)({
+        locales: options.locales || linguiConfig.locales,
+        linguiConfig,
+        clean: options.clean,
+        format,
+        messages,
+        entryPoint,
+        overwrite: options.overwrite,
+        outputPattern: config.output
+      })).statMessage;
+    }
+    stats.push({
+      entry: (0, _utils.normalizeSlashes)(_path.default.relative(linguiConfig.rootDir, entryPoint)),
+      content: output
+    });
+  }
+
+  // cleanup temp directory
+  await _promises.default.rm(tempDir, {
+    recursive: true,
+    force: true
+  });
+  stats.forEach(({
+    entry,
+    content
+  }) => {
+    console.log([`Catalog statistics for ${entry}:`, content, ""].join("\n"));
+  });
+  return commandSuccess;
+}
+if (require.main === module) {
+  var _options$locale;
+  _commander.program.option("--config <path>", "Path to the config file").option("--template", "Extract to template").option("--overwrite", "Overwrite translations for source locale").option("--clean", "Remove obsolete translations").option("--locale <locale, [...]>", "Only extract the specified locales").option("--verbose", "Verbose output").parse(process.argv);
+  const options = _commander.program.opts();
+  const config = (0, _conf.getConfig)({
+    configPath: options.config
+  });
+  const result = command(config, {
+    verbose: options.verbose || false,
+    template: options.template,
+    locales: (_options$locale = options.locale) === null || _options$locale === void 0 ? void 0 : _options$locale.split(","),
+    overwrite: options.overwrite,
+    clean: options.clean
+  }).then(() => {
+    if (!result) process.exit(1);
+  });
+}

package/build/lingui-extract.js

@@ -49,7 +49,7 @@ async function command(config, options) {
   // 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);
-    (specifier => new Promise(r => r(specifier)).then(s => _interopRequireWildcard(require(s))))(`./services/${moduleName}`).then(module => module.default(config, options)).catch(err => console.error(`Can't load service module ${moduleName}`, err));
+    await (specifier => new Promise(r => r(specifier)).then(s => _interopRequireWildcard(require(s))))(`./services/${moduleName}`).then(module => module.default(config, options)).catch(err => console.error(`Can't load service module ${moduleName}`, err));
   }
   return commandSuccess;
 }

package/build/lingui.js

@@ -3,4 +3,4 @@
 
 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);
+_commander.program.version(_package.version).command("extract [files...]", "Extracts messages from source files").command("extract-experimental", "Extracts messages from source files traversing dependency tree").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

@@ -52,18 +52,18 @@ function init(config, options, successCallback, failCallback) {
   const sourceLocale = config.sourceLocale || "en";
   const targetLocales = getTargetLocales(config);
   const paths = poPathsPerLocale(config);
-  let segments = {};
+  const segments = {};
   targetLocales.forEach(targetLocale => {
     segments[targetLocale] = [];
   });
 
   // Create segments from source locale PO items
   paths[sourceLocale].forEach(path => {
-    let raw = _fs.default.readFileSync(path).toString();
-    let po = _pofile.default.parse(raw);
+    const raw = _fs.default.readFileSync(path).toString();
+    const po = _pofile.default.parse(raw);
     po.items.filter(item => !item["obsolete"]).forEach(item => {
       targetLocales.forEach(targetLocale => {
-        let newSegment = createSegmentFromPoItem(item);
+        const newSegment = createSegmentFromPoItem(item);
         segments[targetLocale].push(newSegment);
       });
     });
@@ -72,14 +72,14 @@ function init(config, options, successCallback, failCallback) {
   // Add translations to segments from target locale PO items
   targetLocales.forEach(targetLocale => {
     paths[targetLocale].forEach(path => {
-      let raw = _fs.default.readFileSync(path).toString();
-      let po = _pofile.default.parse(raw);
+      const raw = _fs.default.readFileSync(path).toString();
+      const po = _pofile.default.parse(raw);
       po.items.filter(item => !item["obsolete"]).forEach((item, index) => {
         segments[targetLocale][index].target = item.msgstr[0];
       });
     });
   });
-  let request = {
+  const request = {
     client: "lingui",
     version: require("@lingui/core/package.json").version,
     source_language: sourceLocale,
@@ -104,29 +104,26 @@ function sync(config, options, successCallback, failCallback) {
   const sourceLocale = config.sourceLocale || "en";
   const targetLocales = getTargetLocales(config);
   const paths = poPathsPerLocale(config);
-  let segments = [];
+  const segments = [];
 
   // Create segments with correct source
   paths[sourceLocale].forEach(path => {
-    let raw = _fs.default.readFileSync(path).toString();
-    let po = _pofile.default.parse(raw);
+    const raw = _fs.default.readFileSync(path).toString();
+    const po = _pofile.default.parse(raw);
     po.items.filter(item => !item["obsolete"]).forEach(item => {
-      let newSegment = createSegmentFromPoItem(item);
+      const newSegment = createSegmentFromPoItem(item);
       segments.push(newSegment);
     });
   });
-  let request = {
+  const request = {
     client: "lingui",
     version: require("@lingui/core/package.json").version,
     source_language: sourceLocale,
     target_languages: targetLocales,
-    segments: segments
+    segments: segments,
+    // Sync and then remove unused segments (not present in the local application) from Translation.io
+    purge: Boolean(options.clean)
   };
-
-  // Sync and then remove unused segments (not present in the local application) from Translation.io
-  if (options.clean) {
-    request["purge"] = true;
-  }
   postTio("sync", request, config.service.apiKey, response => {
     if (response.errors) {
       failCallback(response.errors);
@@ -139,8 +136,8 @@ function sync(config, options, successCallback, failCallback) {
   });
 }
 function createSegmentFromPoItem(item) {
-  let itemHasId = item.msgid != item.msgstr[0] && item.msgstr[0].length;
-  let segment = {
+  const itemHasId = item.msgid != item.msgstr[0] && item.msgstr[0].length;
+  const segment = {
     type: "source",
     // No way to edit text for source language (inside code), so not using "key" here
     source: itemHasId ? item.msgstr[0] : item.msgid,
@@ -161,7 +158,7 @@ function createSegmentFromPoItem(item) {
   return segment;
 }
 function createPoItemFromSegment(segment) {
-  let item = new _pofile.default.Item();
+  const item = new _pofile.default.Item();
   item.msgid = segment.context ? segment.context : segment.source;
   item.msgstr = [segment.target];
   item.references = segment.references && segment.references.length ? segment.references : [];
@@ -190,11 +187,11 @@ function saveSegmentsToTargetPos(config, paths, segmentsPerLocale) {
     // Find target path (ignoring {name})
     const localePath = "".concat(config.catalogs[0].path.replace(/{locale}/g, targetLocale).replace(/{name}/g, ""), ".po");
     const segments = segmentsPerLocale[targetLocale];
-    let po = new _pofile.default();
+    const po = new _pofile.default();
     po.headers = getCreateHeaders(targetLocale);
-    let items = [];
+    const items = [];
     segments.forEach(segment => {
-      let item = createPoItemFromSegment(segment);
+      const item = createPoItemFromSegment(segment);
       items.push(item);
     });
 
@@ -224,7 +221,7 @@ function saveSegmentsToTargetPos(config, paths, segmentsPerLocale) {
   });
 }
 function poPathsPerLocale(config) {
-  const paths = [];
+  const paths = {};
   config.locales.forEach(locale => {
     paths[locale] = [];
     config.catalogs.forEach(catalog => {
@@ -241,23 +238,23 @@ function poPathsPerLocale(config) {
   return paths;
 }
 function postTio(action, request, apiKey, successCallback, failCallback) {
-  let jsonRequest = JSON.stringify(request);
-  let options = {
+  const jsonRequest = JSON.stringify(request);
+  const options = {
     hostname: "translation.io",
-    path: "/api/v1/segments/" + action + ".json?api_key=" + apiKey,
+    path: `/api/v1/segments/${action}.json?api_key=${apiKey}`,
     method: "POST",
     headers: {
       "Content-Type": "application/json"
     }
   };
-  let req = _https.default.request(options, res => {
+  const req = _https.default.request(options, res => {
     res.setEncoding("utf8");
     let body = "";
     res.on("data", chunk => {
       body = body.concat(chunk);
     });
     res.on("end", () => {
-      let response = JSON.parse(body);
+      const response = JSON.parse(body);
       successCallback(response);
     });
   });

package/build/tests.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.copyFixture = copyFixture;
+exports.createFixtures = createFixtures;
 exports.defaultMergeOptions = exports.defaultMakeTemplateOptions = exports.defaultMakeOptions = void 0;
 exports.listingToHumanReadable = listingToHumanReadable;
 exports.makeCatalog = void 0;
@@ -93,6 +94,26 @@ function listingToHumanReadable(listing) {
   });
   return output.join("\n");
 }
+
+/**
+ * Create fixtures from provided listing in temp folder
+ * Alternative for mock-fs which is also mocking nodejs require calls
+ * @param listing
+ */
+async function createFixtures(listing) {
+  const tmpDir = await _fs.default.promises.mkdtemp(_path.default.join(_os.default.tmpdir(), `lingui-test-${process.pid}`));
+  async function create(listing) {
+    for (const [filename, value] of Object.entries(listing)) {
+      if (typeof value === "string") {
+        await _fs.default.promises.writeFile(_path.default.join(tmpDir, filename), value);
+      } else {
+        await create(value);
+      }
+    }
+  }
+  await create(listing);
+  return tmpDir;
+}
 function readFsToJson(directory, filter) {
   const out = {};
   _fs.default.readdirSync(directory).map(filename => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/cli",
-  "version": "4.0.0-next.0",
+  "version": "4.0.0-next.2",
   "description": "CLI for working wit message catalogs",
   "keywords": [
     "cli",
@@ -45,33 +45,32 @@
     "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": "^4.0.0-next.0",
-    "@lingui/conf": "^4.0.0-next.0",
-    "@lingui/core": "^4.0.0-next.0",
+    "@babel/core": "^7.21.0",
+    "@babel/generator": "^7.21.1",
+    "@babel/parser": "^7.21.2",
+    "@babel/runtime": "^7.21.0",
+    "@babel/types": "^7.21.2",
+    "@lingui/babel-plugin-extract-messages": "^4.0.0-next.2",
+    "@lingui/conf": "^4.0.0-next.2",
+    "@lingui/core": "^4.0.0-next.2",
     "@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": "^10.0.0",
     "convert-source-map": "^2.0.0",
     "date-fns": "^2.16.1",
+    "esbuild": "^0.17.10",
     "glob": "^7.1.4",
     "inquirer": "^7.3.3",
-    "make-plural": "^6.2.2",
     "micromatch": "4.0.2",
     "mkdirp": "^1.0.4",
     "node-gettext": "^3.0.0",
     "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.4",
     "pseudolocale": "^1.1.0",
@@ -88,5 +87,5 @@
     "mock-fs": "^5.2.0",
     "mockdate": "^3.0.2"
   },
-  "gitHead": "637f5cf6beda9d4ebce4e15cd9fdaa23e404b660"
+  "gitHead": "556ab57e20c2ac9d384a22424c6a90c2ba0dd133"
 }

package/build/api/locales.js

@@ -1,36 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isValid = isValid;
-exports.parse = parse;
-var plurals = _interopRequireWildcard(require("make-plural/plurals"));
-var _bcp = _interopRequireDefault(require("bcp-47"));
-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; }
-/**
- * Check that locale is valid according to BCP47 and we have plurals for it
- * @param locale: string - Locale in BCP47 format
- * @return {boolean}
- */
-function isValid(locale) {
-  const localeData = parse(locale);
-  return localeData !== null && localeData !== undefined && localeData.language in plurals;
-}
-
-/**
- * Parse locale in BCP47 format and
- * @param locale - Locale in BCP47 format
- * @return {LocaleInfo}
- */
-function parse(locale) {
-  if (typeof locale !== "string") return null;
-  const schema = _bcp.default.parse(locale.replace("_", "-"));
-  if (!schema.language) return null;
-  return {
-    locale: _bcp.default.stringify(schema),
-    language: schema.language
-  };
-}