refactor(extractor/babel)!: sealed, non-fragile babel extractor optio…

…ns (#1367)
lingui · Feb 14, 2023 · 2d5a6ff · 2d5a6ff
1 parent dd5f1c7
commit 2d5a6ff
Show file tree

Hide file tree

Showing 43 changed files with 964 additions and 749 deletions.
diff --git a/examples/js/package.json b/examples/js/package.json
@@ -20,7 +20,7 @@
     "@babel/preset-env": "^7.20.2",
     "@lingui/cli": "^3.5.1",
     "babel-jest": "^26.6.1",
-    "babel-plugin-macros": "^2.8.0",
+    "babel-plugin-macros": "^3.1.0",
     "jest": "^26.6.1"
   }
 }
diff --git a/package.json b/package.json
@@ -58,7 +58,7 @@
     "@typescript-eslint/parser": "^5.50.0",
     "babel-eslint": "^10.1.0",
     "babel-jest": "^26.5.2",
-    "babel-plugin-macros": "^2.8.0",
+    "babel-plugin-macros": "^3.1.0",
     "chalk": "^4.1.0",
     "codecov": "^3.8.1",
     "cross-env": "^7.0.2",

diff --git a/packages/babel-plugin-extract-messages/test/index.ts b/packages/babel-plugin-extract-messages/test/index.ts
@@ -18,7 +18,6 @@ const transformCode = (
   filename = "test-case.js",
   rootDir = "."
 ) => {
-  process.env.LINGUI_EXTRACT = "1"
   process.env.LINGUI_CONFIG = path.join(
     __dirname,
     "fixtures",
@@ -45,6 +44,7 @@ const transformCode = (
         [
           "macros",
           {
+            lingui: { extract: true },
             // macro plugin uses package `resolve` to find a path of macro file
             // this will not follow jest pathMapping and will resolve path from ./build
             // instead of ./src which makes testing & developing hard.
@@ -56,7 +56,6 @@ const transformCode = (
       ],
     })
   } finally {
-    process.env.LINGUI_EXTRACT = null
     process.env.LINGUI_CONFIG = null
   }
 

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -50,6 +50,7 @@
     "@babel/plugin-syntax-jsx": "^7.18.6",
     "@babel/runtime": "^7.20.13",
     "@babel/types": "^7.20.7",
+    "@babel/core": "^7.20.12",
     "@lingui/babel-plugin-extract-messages": "3.17.1",
     "@lingui/conf": "3.17.1",
     "@lingui/core": "3.17.1",
@@ -71,7 +72,6 @@
     "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",
@@ -83,11 +83,6 @@
     "@types/papaparse": "^5.2.3",
     "@types/plurals-cldr": "^1.0.1",
     "mockdate": "^3.0.2",
-    "typescript": "^4.9.5"
-  },
-  "peerDependencies": {
-    "@babel/core": "^7.0.0",
-    "babel-plugin-macros": "2 || 3",
-    "typescript": "2 || 3 || 4"
+    "fs-extra": "^9.0.1"
   }
 }
diff --git a/packages/cli/src/api/__snapshots__/catalog.test.ts.snap b/packages/cli/src/api/__snapshots__/catalog.test.ts.snap
@@ -118,7 +118,84 @@ Object {
 }
 `;
 
-exports[`Catalog collect should handle errors 1`] = `undefined`;
+exports[`Catalog collect should support Flow syntax if enabled 1`] = `Object {}`;
+
+exports[`Catalog collect should support JSX and Typescript 1`] = `
+Object {
+  Description: Object {
+    extractedComments: Array [
+      description,
+    ],
+    message: undefined,
+    origin: Array [
+      Array [
+        collect-typescript-jsx/macro.tsx,
+        6,
+      ],
+    ],
+  },
+  Hi, my name is {name}: Object {
+    extractedComments: Array [],
+    message: undefined,
+    origin: Array [
+      Array [
+        collect-typescript-jsx/macro.tsx,
+        17,
+      ],
+    ],
+  },
+  ID Some: Object {
+    extractedComments: Array [],
+    message: Message with id some,
+    origin: Array [
+      Array [
+        collect-typescript-jsx/macro.tsx,
+        11,
+      ],
+    ],
+  },
+  Message: Object {
+    extractedComments: Array [],
+    message: undefined,
+    origin: Array [
+      Array [
+        collect-typescript-jsx/macro.tsx,
+        4,
+      ],
+    ],
+  },
+  Some message: Object {
+    extractedComments: Array [],
+    message: undefined,
+    origin: Array [
+      Array [
+        collect-typescript-jsx/macro.tsx,
+        18,
+      ],
+    ],
+  },
+  Title: Object {
+    extractedComments: Array [],
+    message: undefined,
+    origin: Array [
+      Array [
+        collect-typescript-jsx/macro.tsx,
+        19,
+      ],
+    ],
+  },
+  {count, plural, one {# book} other {# books}}: Object {
+    extractedComments: Array [],
+    message: undefined,
+    origin: Array [
+      Array [
+        collect-typescript-jsx/macro.tsx,
+        21,
+      ],
+    ],
+  },
+}
+`;
 
 exports[`Catalog make should collect and write catalogs 1`] = `
 Object {

diff --git a/packages/cli/src/api/catalog.test.ts b/packages/cli/src/api/catalog.test.ts
@@ -198,6 +198,49 @@ describe("Catalog", () => {
   })
 
   describe("collect", () => {
+    it("should support JSX and Typescript", async () => {
+      process.env.LINGUI_CONFIG = path.join(
+        __dirname,
+        "fixtures/collect-typescript-jsx/lingui.config.js"
+      )
+      const catalog = new Catalog(
+        {
+          name: "messages",
+          path: "locales/{locale}",
+          include: [fixture("collect-typescript-jsx/")],
+          exclude: [],
+        },
+        mockConfig()
+      )
+
+      const messages = await catalog.collect()
+      expect(messages).toBeTruthy()
+      expect(messages).toMatchSnapshot()
+    })
+
+    it("should support Flow syntax if enabled", async () => {
+      process.env.LINGUI_CONFIG = path.join(
+        __dirname,
+        "fixtures/collect-syntax-flow/lingui.config.js"
+      )
+      const catalog = new Catalog(
+        {
+          name: "messages",
+          path: "locales/{locale}",
+          include: [fixture("collect-syntax-flow/")],
+          exclude: [],
+        },
+        mockConfig({
+          extractorParserOptions: {
+            flow: true,
+          },
+        })
+      )
+
+      const messages = await catalog.collect()
+      expect(messages).toBeTruthy()
+      expect(messages).toMatchSnapshot()
+    })
     it("should extract messages from source files", async () => {
       const catalog = new Catalog(
         {
@@ -209,7 +252,7 @@ describe("Catalog", () => {
         mockConfig()
       )
 
-      const messages = await catalog.collect(defaultMakeOptions)
+      const messages = await catalog.collect()
       expect(messages).toMatchSnapshot()
     })
 
@@ -228,7 +271,6 @@ describe("Catalog", () => {
       )
 
       const messages = await catalog.collect({
-        ...defaultMakeOptions,
         files: [fixture("collect/componentA")],
       })
       expect(messages).toMatchSnapshot()
@@ -247,7 +289,6 @@ describe("Catalog", () => {
 
       mockConsole(async (console) => {
         await catalog.collect({
-          ...defaultMakeOptions,
           files: [fixture("duplicate-id.js")],
         })
 
@@ -271,7 +312,7 @@ describe("Catalog", () => {
       )
 
       mockConsole(async (console) => {
-        const messages = await catalog.collect(defaultMakeOptions)
+        const messages = await catalog.collect()
         expect(console.error).toBeCalledWith(
           expect.stringContaining(`Cannot process file`)
         )

diff --git a/packages/cli/src/api/catalog.ts b/packages/cli/src/api/catalog.ts
@@ -11,7 +11,7 @@ import getFormat, {
   CatalogFormatOptionsInternal,
   CatalogFormatter,
 } from "./formats"
-import extract, { ExtractedMessage } from "./extractors"
+import extract, { ExtractedMessage, ExtractorType } from "./extractors"
 import { CliExtractOptions } from "../lingui-extract"
 import { CliExtractTemplateOptions } from "../lingui-extract-template"
 import { CompiledCatalogNamespace } from "./compile"
@@ -54,17 +54,13 @@ export type AllCatalogsType = {
 }
 
 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
   files?: string[]
@@ -115,7 +111,7 @@ export class Catalog {
   }
 
   async make(options: MakeOptions): Promise<boolean> {
-    const nextCatalog = await this.collect(options)
+    const nextCatalog = await this.collect({ files: options.files })
     if (!nextCatalog) return false
     const prevCatalogs = this.readAll()
 
@@ -145,7 +141,7 @@ export class Catalog {
   }
 
   async makeTemplate(options: MakeTemplateOptions): Promise<boolean> {
-    const catalog = await this.collect(options)
+    const catalog = await this.collect({ files: options.files })
     if (!catalog) return false
     const sort = order<CatalogType>(options.orderBy)
     this.writeTemplate(sort(catalog as CatalogType))
@@ -156,7 +152,7 @@ export class Catalog {
    * Collect messages from source paths. Return a raw message catalog as JSON.
    */
   async collect(
-    options: CollectOptions
+    options: { files?: string[] } = {}
   ): Promise<ExtractedCatalogType | undefined> {
     const messages: ExtractedCatalogType = {}
 
@@ -207,10 +203,8 @@ export class Catalog {
           }
         },
         {
-          verbose: options.verbose,
-          babelOptions: this.config.extractBabelOptions,
-          extractors: options.extractors,
-          projectType: options.projectType,
+          parserOptions: this.config.extractorParserOptions,
+          extractors: this.config.extractors as ExtractorType[],
         }
       )
       catalogSuccess &&= fileSuccess

diff --git a/packages/cli/src/api/detect.test.ts b/packages/cli/src/api/detect.test.ts
diff --git a/packages/cli/src/api/detect.ts b/packages/cli/src/api/detect.ts