Merge pull request #814 from ThiefMaster/extract-pot

Add `lingui extract-template` command

Author: tricoder42

docs/ref/cli.rst

@@ -73,6 +73,17 @@ Convert message catalogs from previous format (see :conf:`format` option).
 
 Prints additional information.
 
+``extract-template``
+--------------------
+
+.. lingui-cli:: extract-template [--verbose]
+
+This command extracts messages from source files and creates a ``.pot`` template file.
+
+.. lingui-cli-option:: --verbose
+
+Prints additional information.
+
 ``compile``
 -----------
 

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

@@ -211,6 +211,39 @@ Object {
 }
 `;
 
+exports[`Catalog makeTemplate should collect and write a template 1`] = `null`;
+
+exports[`Catalog makeTemplate should collect and write a template 2`] = `
+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 read should read file in given format 1`] = `
 Object {
   obsolete: Object {

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

@@ -17,6 +17,7 @@ import { createCompiledCatalog } from "./compile"
 import {
   copyFixture,
   defaultMakeOptions,
+  defaultMakeTemplateOptions,
   makeNextMessage,
   defaultMergeOptions,
   makeCatalog,
@@ -80,6 +81,32 @@ describe("Catalog", function () {
     })
   })
 
+  describe("makeTemplate", function () {
+    it("should collect and write a template", 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.readTemplate()).toMatchSnapshot()
+
+      catalog.makeTemplate(defaultMakeTemplateOptions)
+      expect(catalog.readTemplate()).toMatchSnapshot()
+    })
+  })
+
   describe("collect", function () {
     it("should extract messages from source files", function () {
       const catalog = new Catalog(

packages/cli/src/api/catalog.ts

@@ -21,16 +21,25 @@ import {
   CatalogType,
 } from "./types"
 import { CliExtractOptions } from "../lingui-extract"
+import { CliExtractTemplateOptions } from "../lingui-extract-template"
 
 const NAME = "{name}"
 const LOCALE = "{locale}"
+const LOCALE_SUFFIX_RE = /\{locale\}.*$/
 const PATHSEP = "/" // force posix everywhere
 
 export type MakeOptions = CliExtractOptions & {
   projectType?: string
   orderBy?: OrderBy
 }
 
+export type MakeTemplateOptions = CliExtractTemplateOptions & {
+  projectType?: string
+  orderBy?: OrderBy
+}
+
+type CollectOptions = MakeOptions | MakeTemplateOptions
+
 export type MergeOptions = {
   overwrite: boolean
 }
@@ -87,10 +96,16 @@ export class Catalog {
     this.writeAll(cleanAndSort(catalogs))
   }
 
+  makeTemplate(options: MakeTemplateOptions) {
+    const catalog = this.collect(options)
+    const sort = order(options.orderBy) as (catalog: CatalogType) => CatalogType
+    this.writeTemplate(sort(catalog as CatalogType))
+  }
+
   /**
    * Collect messages from source paths. Return a raw message catalog as JSON.
    */
-  collect(options: MakeOptions) {
+  collect(options: CollectOptions) {
     const tmpDir = path.join(os.tmpdir(), `lingui-${process.pid}`)
 
     if (fs.existsSync(tmpDir)) {
@@ -251,6 +266,17 @@ export class Catalog {
     this.locales.forEach((locale) => this.write(locale, catalogs[locale]))
   }
 
+  writeTemplate(messages: CatalogType) {
+    const filename = this.templateFile
+    const basedir = path.dirname(filename)
+    if (!fs.existsSync(basedir)) {
+      fs.mkdirpSync(basedir)
+    }
+    const options = { ...this.config.formatOptions, locale: undefined }
+    const poFormat = getFormat("po")
+    poFormat.write(filename, messages, options)
+  }
+
   writeCompiled(locale: string, compiledCatalog: string, namespace?: string) {
     const ext = `.${namespace === "es" ? "mjs" : "js"}`
     const filename = this.path.replace(LOCALE, locale) + ext
@@ -279,6 +305,12 @@ export class Catalog {
     ) as AllCatalogsType
   }
 
+  readTemplate() {
+    const filename = this.templateFile
+    if (!fs.existsSync(filename)) return null
+    return this.format.read(filename)
+  }
+
   get sourcePaths() {
     const includeGlobs = this.include.map(
       (includePath) =>
@@ -291,6 +323,10 @@ export class Catalog {
     return glob.sync(patterns, { ignore: this.exclude, mark: true })
   }
 
+  get templateFile() {
+    return this.path.replace(LOCALE_SUFFIX_RE, "messages.pot")
+  }
+
   get localeDir() {
     const localePatternIndex = this.path.indexOf(LOCALE)
     if (localePatternIndex === -1) {

packages/cli/src/api/formats/po.ts

@@ -89,6 +89,9 @@ const po: CatalogFormatter = {
     } else {
       po = new PO()
       po.headers = getCreateHeaders(options.locale)
+      if (options.locale === undefined) {
+        delete po.headers.Language;
+      }
       po.headerOrder = R.keys(po.headers)
     }
     po.items = serialize(catalog, options)

packages/cli/src/lingui-extract-template.ts

@@ -0,0 +1,65 @@
+import chalk from "chalk"
+import program from "commander"
+
+import { getConfig, LinguiConfig } from "@lingui/conf"
+
+import { getCatalogs } from "./api/catalog"
+import { detect } from "./api/detect"
+
+export type CliExtractTemplateOptions = {
+  verbose: boolean
+}
+
+export default function command(
+  config: LinguiConfig,
+  options: Partial<CliExtractTemplateOptions>
+): boolean {
+  // `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 = getCatalogs(config)
+  const catalogStats: { [path: string]: Number } = {}
+  catalogs.forEach((catalog) => {
+    catalog.makeTemplate({
+      ...options,
+      orderBy: config.orderBy,
+      projectType: detect(),
+    })
+
+    catalogStats[catalog.templateFile] = Object.keys(catalog.readTemplate()).length
+  })
+
+  Object.entries(catalogStats).forEach(([key, value]) => {
+    console.log(
+      `Catalog statistics for ${chalk.bold(key)}: ${chalk.green(
+        value
+      )} messages`
+    )
+    console.log()
+  })
+  return true
+}
+
+if (require.main === module) {
+  program
+    .option("--config <path>", "Path to the config file")
+    .option("--verbose", "Verbose output")
+    .parse(process.argv)
+
+  const config = getConfig({ configPath: program.config })
+
+  const result = command(config, {
+    verbose: program.verbose || false,
+  })
+
+  if (!result) process.exit(1)
+}

packages/cli/src/lingui.ts

@@ -15,6 +15,7 @@ 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)
 

packages/cli/src/tests.ts

@@ -3,7 +3,7 @@ import fs from "fs-extra"
 import path from "path"
 
 import { mockConfig } from "@lingui/jest-mocks"
-import { Catalog, MakeOptions, MergeOptions } from "./api/catalog"
+import { Catalog, MakeOptions, MakeTemplateOptions, MergeOptions } from "./api/catalog"
 import { ExtractedMessageType, MessageType } from "./api/types"
 
 export function copyFixture(fixtureDir) {
@@ -25,6 +25,11 @@ export const defaultMakeOptions: MakeOptions = {
   orderBy: "messageId",
 }
 
+export const defaultMakeTemplateOptions: MakeTemplateOptions = {
+  verbose: false,
+  orderBy: "messageId",
+}
+
 export const defaultMergeOptions: MergeOptions = {
   overwrite: false,
 }