feat(experimental-extractor): reconsider includeDeps (#2362)

Author: Timofei Iatsenko

packages/cli/src/extract-experimental/buildIncludeDepsFilter.test.ts

@@ -0,0 +1,13 @@
+import { buildIncludeDepsFilter } from "./buildIncludeDepsFilter"
+
+describe("buildExternalizeFilter", () => {
+  it("should not externalize packages from includeDeps", () => {
+    const isIncluded = buildIncludeDepsFilter(["package1", "package3/subpath"])
+
+    expect(isIncluded("package1")).toBeTruthy()
+    expect(isIncluded("package1/subpath")).toBeTruthy()
+    expect(isIncluded("package2")).toBeFalsy()
+    expect(isIncluded("package3/subpath")).toBeTruthy()
+    expect(isIncluded("package3/subpath/subpath")).toBeTruthy()
+  })
+})

packages/cli/src/extract-experimental/buildIncludeDepsFilter.ts

@@ -0,0 +1,9 @@
+function createPackageRegExp(packageName: string) {
+  return new RegExp("^" + packageName + "(?:\\/.+)?")
+}
+
+export function buildIncludeDepsFilter(includeDeps: string[]) {
+  const include = includeDeps.map(createPackageRegExp)
+
+  return (id: string) => include.some((regExp) => regExp.test(id))
+}

packages/cli/src/extract-experimental/bundleSource.ts

@@ -1,6 +1,7 @@
 import { LinguiConfigNormalized } from "@lingui/conf"
 import { BuildOptions } from "esbuild"
 import { pluginLinguiMacro } from "./linguiEsbuildPlugin"
+import { buildIncludeDepsFilter } from "./buildIncludeDepsFilter"
 
 function createExtRegExp(extensions: string[]) {
   return new RegExp("\\.(?:" + extensions.join("|") + ")(?:\\?.*)?$")
@@ -49,11 +50,29 @@ export async function bundleSource(
     sourcemap: "inline",
     sourceRoot: outDir,
     sourcesContent: false,
-    packages: "external",
     metafile: true,
 
     plugins: [
       pluginLinguiMacro({ linguiConfig }),
+      {
+        name: "externalize-deps",
+        setup(build) {
+          const shouldInclude = buildIncludeDepsFilter(config.includeDeps || [])
+
+          // considers all import paths that "look like" package imports in the original source code to be package imports.
+          // Specifically import paths that don't start with a path segment of / or . or .. are considered to be package imports.
+          // The only two exceptions to this rule are subpath imports (which start with a # character) and deps specified in the `includeDeps`
+          build.onResolve({ filter: /^[^.#/].*/ }, async (args) => {
+            if (shouldInclude(args.path)) {
+              return { external: false }
+            }
+
+            return {
+              external: true,
+            }
+          })
+        },
+      },
       {
         name: "externalize-files",
         setup(build) {

packages/cli/test/extractor-experimental-template/expected/about.page.en.js

@@ -6,7 +6,7 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "X-Generator: @lingui/cli\n"
 
-#: fixtures/pages/about.page.tsx:16
+#: fixtures/pages/about.page.tsx:19
 msgid "about page message"
 msgstr ""
 
@@ -18,6 +18,10 @@ msgstr ""
 msgid "header message"
 msgstr ""
 
-#: fixtures/pages/about.page.tsx:19
+#: fixtures/pages/about.page.tsx:22
 msgid "JSX: about page message"
 msgstr ""
+
+#: fixtures/components/subpath-import.ts:3
+msgid "subpath import module message"
+msgstr ""

packages/cli/test/extractor-experimental-template/expected/about.page.messages.pot

@@ -0,0 +1,3 @@
+import { t } from "@lingui/core/macro"
+
+export const msg = t`subpath import module message`

packages/cli/test/extractor-experimental-template/expected/about.page.pl.js

@@ -13,10 +13,13 @@ import styles2 from "./styles.css?inline"
 // should respect tsconfig path aliases
 import { msg as msg2 } from "@alias"
 
+// should respect package.json subpath imports
+import { msg as msg3 } from "#subpath-dep"
+
 const msg = t`about page message`
 
 export default function Page() {
   return <Trans>JSX: about page message</Trans>
 }
 
-console.log(msg, headerMsg, bla, styles, styles2, msg2)
+console.log(msg, headerMsg, bla, styles, styles2, msg2, msg3)

packages/cli/test/extractor-experimental-template/fixtures/components/subpath-import.ts

@@ -9,6 +9,7 @@ export default defineConfig({
     extractor: {
       entries: ["<rootDir>/fixtures/pages/**/*.page.{ts,tsx}"],
       output: "<rootDir>/actual/{entryName}.{locale}",
+      includeDeps: ["@alias"],
     },
   },
 })

packages/cli/test/extractor-experimental-template/fixtures/pages/about.page.tsx

@@ -2,6 +2,9 @@
   "name": "extractor-experimental-template",
   "version": "1.0.0",
   "private": true,
+  "imports": {
+    "#subpath-dep": "./fixtures/components/subpath-import.ts"
+  },
   "dependencies": {
     "@lingui/core": "*",
     "@lingui/react": "*",