feat: add metro transformer (#1999)

Author: vonovak

jest.config.integration.js

@@ -7,7 +7,8 @@ module.exports = {
   ...sourceConfig,
   projects: sourceConfig.projects.map((project) => ({
     ...project,
-    // Redirect imports to the compiled bundles
+    // Redirect imports to the compiled bundles.
+    // This is to test compiled code instead of source (applies to code under test and also its deps).
     moduleNameMapper: {},
   })),
 

jest.config.js

@@ -62,6 +62,7 @@ module.exports = {
         "<rootDir>/packages/cli",
         "<rootDir>/packages/conf",
         "<rootDir>/packages/loader",
+        "<rootDir>/packages/metro-transformer",
         "<rootDir>/packages/macro",
         "<rootDir>/packages/vite-plugin",
         "<rootDir>/packages/format-po",

package.json

@@ -11,7 +11,7 @@
     "test": "jest",
     "test:ci": "jest --ci --runInBand",
     "test:ci:coverage": "yarn test:ci --coverage",
-    "test:integration": "jest -c jest.config.integration.js",
+    "test:integration": "yarn node --experimental-vm-modules $(yarn bin jest) -c jest.config.integration.js",
     "test:e2e": "yarn workspaces foreach -p run test:e2e",
     "test:tsd": "jest -c jest.config.types.js",
     "test:all": "yarn test && yarn test:integration && yarn test:e2e && yarn test:tsd",
@@ -51,7 +51,7 @@
     "@typescript-eslint/eslint-plugin": "^5.50.0",
     "@typescript-eslint/parser": "^5.50.0",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^29.4.3",
+    "babel-jest": "^29.7.0",
     "chalk": "^4.1.0",
     "cross-env": "^7.0.2",
     "eslint": "^7.32.0",
@@ -61,9 +61,9 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.1.1",
     "husky": "^8.0.3",
-    "jest": "^29.4.3",
-    "jest-environment-jsdom": "^29.4.3",
-    "jest-environment-node-single-context": "^29.0.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-environment-node-single-context": "^29.4.0",
     "jest-runner-tsd": "^4.0.0",
     "lerna": "^6.5.1",
     "lint-staged": "^13.1.0",
@@ -78,7 +78,7 @@
     "size-limit": "^8.1.1",
     "strip-ansi": "^6.0.1",
     "swc-node": "^1.0.0",
-    "ts-jest": "^29.0.5",
+    "ts-jest": "^29.2.4",
     "typescript": "^4.9.5"
   },
   "workspaces": [

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

@@ -18,8 +18,10 @@ export async function getTranslationsForCatalog(
   locale: string,
   options: GetTranslationsOptions
 ) {
-  const catalogs = await catalog.readAll()
-  const template = (await catalog.readTemplate()) || {}
+  const [catalogs, template] = await Promise.all([
+    catalog.readAll(),
+    catalog.readTemplate(),
+  ])
 
   const sourceLocaleCatalog = catalogs[options.sourceLocale] || {}
 

packages/cli/src/lingui-extract.ts

@@ -60,14 +60,14 @@ export default async function command(
 
   if (!options.watch) {
     console.log(
-      `(use "${chalk.yellow(
+      `(Use "${chalk.yellow(
         helpRun("extract")
-      )}" to update catalogs with new messages)`
+      )}" to update catalogs with new messages.)`
     )
     console.log(
-      `(use "${chalk.yellow(
+      `(Use "${chalk.yellow(
         helpRun("compile")
-      )}" to compile catalogs for production)`
+      )}" to compile catalogs for production. Alternatively, use bundler plugins: https://lingui.dev/ref/cli#compiling-catalogs-in-ci)`
     )
   }
 

packages/cli/test/index.test.ts

@@ -73,8 +73,8 @@ describe("E2E Extractor Test", () => {
         │ pl          │      8      │    8    │
         └─────────────┴─────────────┴─────────┘
 
-        (use "yarn extract" to update catalogs with new messages)
-        (use "yarn compile" to compile catalogs for production)
+        (Use "yarn extract" to update catalogs with new messages.)
+        (Use "yarn compile" to compile catalogs for production. Alternatively, use bundler plugins: https://lingui.dev/ref/cli#compiling-catalogs-in-ci)
       `)
     })
 

packages/conf/src/getConfig.ts

@@ -71,7 +71,7 @@ export function getConfig({
     )
 
     // gracefully stop further executing
-    throw new Error("No Config")
+    throw new Error("No Lingui config found")
   }
 
   const userConfig = result ? result.config : {}

packages/loader/src/webpackLoader.ts

@@ -54,11 +54,10 @@ Please check that \`catalogs.path\` is filled properly.\n`
     sourceLocale: config.sourceLocale,
   })
 
-  // In production we don't want untranslated strings. It's better to use message
+  // In production, we don't want untranslated strings. It's better to use message
   // keys as a last resort.
   // In development, however, we want to catch missing strings with `missing` parameter
-  // of I18nProvider (React) or setupI18n (core) and therefore we need to get
-  // empty translations if missing.
+  // of setupI18n (core) and therefore we need to get empty translations if missing.
   const strict = process.env.NODE_ENV !== "production"
 
   return createCompiledCatalog(locale, messages, {

packages/metro-transformer/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+### Features
+
+- initial implementation of metro transformer [#1999](https://github.com/lingui/js-lingui/pull/1999)

packages/metro-transformer/README.md

@@ -0,0 +1,27 @@
+[![License][badge-license]][license]
+[![Version][badge-version]][package]
+[![Downloads][badge-downloads]][package]
+
+# @lingui/metro-transformer
+
+> Metro bundler transformer for LinguiJS catalogs
+
+`@lingui/metro-transformer` is part of [LinguiJS][linguijs]. See the
+[documentation][documentation] for all information, tutorials and examples.
+
+## Installation & Usage
+
+See the [reference][reference] documentation.
+
+## License
+
+This package is licensed under [MIT][license] license.
+
+[license]: https://github.com/lingui/js-lingui/blob/main/LICENSE
+[linguijs]: https://github.com/lingui/js-lingui
+[documentation]: https://lingui.dev
+[reference]: https://lingui.dev/ref/metro-transformer
+[package]: https://www.npmjs.com/package/@lingui/metro-transformer
+[badge-downloads]: https://img.shields.io/npm/dw/@lingui/metro-transformer.svg
+[badge-version]: https://img.shields.io/npm/v/@lingui/metro-transformer.svg
+[badge-license]: https://img.shields.io/npm/l/@lingui/metro-transformer.svg