feat: add cli option to extract only a specific locale (#816)

Author: ThiefMaster

docs/ref/cli.rst

@@ -43,7 +43,7 @@ Commands
 ``extract``
 -----------
 
-.. lingui-cli:: extract [--clean] [--overwrite] [--format <format>] [--convert-from <format>] [--verbose]
+.. lingui-cli:: extract [--clean] [--overwrite] [--format <format>] [--locale <locale>] [--convert-from <format>] [--verbose]
 
 This command extracts messages from source files and creates a message catalog for
 each language using the following steps:
@@ -65,6 +65,10 @@ Update translations for :conf:`sourceLocale` from source.
 
 Format of message catalogs (see :conf:`format` option).
 
+.. lingui-cli-option:: --locale <locale>
+
+Only extract data for the specified locale.
+
 .. lingui-cli-option:: --convert-from <format>
 
 Convert message catalogs from previous format (see :conf:`format` option).

packages/cli/src/api/__snapshots__/catalog.test.ts.snap

@@ -211,6 +211,47 @@ Object {
 }
 `;
 
+exports[`Catalog make should only update the specified locale 1`] = `
+Object {
+  cs: null,
+  en: null,
+}
+`;
+
+exports[`Catalog make should only update the specified locale 2`] = `
+Object {
+  cs: null,
+  en: Object {
+    Component A: Object {
+      comment: undefined,
+      comments: Array [],
+      flags: Array [],
+      obsolete: false,
+      origin: Array [
+        Array [
+          collect/componentA/componentA.js,
+          1,
+        ],
+      ],
+      translation: ,
+    },
+    Hello World: Object {
+      comment: undefined,
+      comments: Array [],
+      flags: Array [],
+      obsolete: false,
+      origin: Array [
+        Array [
+          collect/componentA/index.js,
+          1,
+        ],
+      ],
+      translation: ,
+    },
+  },
+}
+`;
+
 exports[`Catalog makeTemplate should collect and write a template 1`] = `null`;
 
 exports[`Catalog makeTemplate should collect and write a template 2`] = `

packages/cli/src/api/catalog.test.ts

@@ -59,6 +59,30 @@ describe("Catalog", function () {
       expect(catalog.readAll()).toMatchSnapshot()
     })
 
+    it("should only update the specified locale", function () {
+      const localeDir = copyFixture(fixture("locales", "initial"))
+      const catalog = new Catalog(
+        {
+          name: "messages",
+          path: path.join(localeDir, "{locale}", "messages"),
+          include: [
+            fixture("collect/componentA/"),
+            fixture("collect/componentB"),
+          ],
+          exclude: [],
+        },
+        mockConfig({
+          locales: ["en", "cs"],
+        })
+      )
+
+      // Everything should be empty
+      expect(catalog.readAll()).toMatchSnapshot()
+
+      catalog.make({ ...defaultMakeOptions, locale: "en" })
+      expect(catalog.readAll()).toMatchSnapshot()
+    })
+
     it("should merge with existing catalogs", function () {
       const localeDir = copyFixture(fixture("locales", "existing"))
       const catalog = new Catalog(

packages/cli/src/api/catalog.ts

@@ -93,7 +93,14 @@ export class Catalog {
         order(options.orderBy)
       )
     ) as unknown) as (catalog: AllCatalogsType) => AllCatalogsType
-    this.writeAll(cleanAndSort(catalogs))
+
+    const sortedCatalogs = cleanAndSort(catalogs);
+
+    if (options.locale) {
+      this.write(options.locale, sortedCatalogs[options.locale])
+    } else {
+      this.writeAll(sortedCatalogs)
+    }
   }
 
   makeTemplate(options: MakeTemplateOptions) {

packages/cli/src/api/stats.ts

@@ -26,7 +26,11 @@ export function printStats(config: LinguiConfig, catalogs: AllCatalogsType) {
   })
 
   Object.keys(catalogs).forEach((locale) => {
-    const [all, translated] = getStats(catalogs[locale])
+    const catalog = catalogs[locale]
+    // catalog is null if no catalog exists on disk and the locale
+    // was not extracted due to a `--locale` filter
+    const [all, translated] = catalog ? getStats(catalog) : ["-", "-"]
+
     if (config.sourceLocale === locale) {
       table.push({ [`${chalk.bold(locale)} (source)`]: [all, "-"] })
     } else {

packages/cli/src/lingui-extract.ts

@@ -13,6 +13,7 @@ export type CliExtractOptions = {
   verbose: boolean
   clean: boolean
   overwrite: boolean
+  locale: string
   prevFormat: string | null
 }
 
@@ -70,6 +71,7 @@ export default function command(
 if (require.main === module) {
   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("--verbose", "Verbose output")
@@ -120,12 +122,19 @@ if (require.main === module) {
     process.exit(1)
   }
 
+  if (program.locale && !config.locales.includes(program.locale)) {
+    hasErrors = true
+    console.error(`Locale ${chalk.bold(program.locale)} does not exist.`)
+    console.error()
+  }
+
   if (hasErrors) process.exit(1)
 
   const result = command(config, {
     verbose: program.verbose || false,
     clean: program.clean || false,
     overwrite: program.overwrite || false,
+    locale: program.locale,
     prevFormat,
   })
 

packages/cli/src/tests.ts

@@ -7,11 +7,10 @@ import { Catalog, MakeOptions, MakeTemplateOptions, MergeOptions } from "./api/c
 import { ExtractedMessageType, MessageType } from "./api/types"
 
 export function copyFixture(fixtureDir) {
-  const tmpDir = path.join(os.tmpdir(), `lingui-test-${process.pid}`)
-
-  if (!fs.existsSync(fixtureDir)) {
-    fs.mkdirpSync(tmpDir)
-  } else {
+  const tmpDir = fs.mkdtempSync(
+    path.join(os.tmpdir(), `lingui-test-${process.pid}`)
+  )
+  if (fs.existsSync(fixtureDir)) {
     fs.copySync(fixtureDir, tmpDir)
   }
   return tmpDir
@@ -21,6 +20,7 @@ export const defaultMakeOptions: MakeOptions = {
   verbose: false,
   clean: false,
   overwrite: false,
+  locale: null,
   prevFormat: null,
   orderBy: "messageId",
 }