refactor(build): simplify build process

- publish packages from package root instead of ./build - remove all manipulation code which move files to the build - change package.json to point to right sources - added inner export targets for packages where it were used - push compileMessage as inner package of `core` - change build system to be able to build separate entries in multi-entry packages
lingui · Jan 13, 2023 · a36fcc0 · a36fcc0
1 parent 66d4618
commit a36fcc0
Show file tree

Hide file tree

Showing 50 changed files with 670 additions and 672 deletions.
diff --git a/package.json b/package.json
@@ -16,17 +16,17 @@
     "lint:types": "tsc",
     "lint:eslint": "eslint packages",
     "lint:all": "yarn lint:eslint && yarn lint:types",
-    "release:build": "node ./scripts/build/",
-    "release:test": "node ./scripts/test.js",
+    "release:build": "node -r @swc-node/register ./scripts/build/index.ts",
+    "release:test": "node -r @swc-node/register  ./scripts/test.ts",
     "version:next": "lerna version --exact --force-publish --no-private --preid next --create-release github --conventional-commits --conventional-prerelease --yes",
     "version:latest": "lerna version --exact --force-publish --no-private --create-release github --conventional-commits --yes",
-    "release:latest": "lerna publish from-package --contents build --dist-tag latest --yes",
-    "release:next": "lerna publish from-package --contents build --canary --preid next --pre-dist-tag next --yes",
+    "release:latest": "lerna publish from-package --dist-tag latest --yes",
+    "release:next": "lerna publish from-package --canary --preid next --pre-dist-tag next --yes",
     "build:docs": "cd docs && ./vercel-build.sh",
     "size-limit": "size-limit"
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=14.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.11.6",
@@ -37,11 +37,16 @@
     "@babel/preset-react": "^7.10.4",
     "@babel/preset-typescript": "^7.10.4",
     "@size-limit/preset-small-lib": "^4.10.1",
+    "@swc/jest": "^0.2.24",
+    "@swc/core": "^1.3.26",
+    "swc-node": "^1.0.0",
     "@testing-library/react": "^11.0.4",
     "@types/babel-types": "^7.0.9",
     "@types/jest": "^26.0.14",
+    "@types/node": "14.14.31",
     "@types/ramda": "^0.27.23",
     "@types/react": "^16.9.51",
+    "@types/rimraf": "^3.0.2",
     "@typescript-eslint/eslint-plugin": "^4.4.0",
     "@typescript-eslint/parser": "^4.4.0",
     "babel-code-frame": "^6.26.0",
@@ -76,7 +81,6 @@
     "node-emoji": "^1.10.0",
     "npm-cli-login": "^0.1.1",
     "ora": "^5.1.0",
-    "pkg-up": "^3.1.0",
     "prettier": "^2.1.2",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
@@ -94,7 +98,6 @@
     "set-tz": "^0.2.0",
     "size-limit": "^4.10.1",
     "strip-ansi": "^6.0.0",
-    "targz": "^1.0.1",
     "tmp": "^0.2.1",
     "ts-jest": "^26.4.1",
     "typescript": "^4.0.3",

diff --git a/packages/babel-plugin-extract-messages/package.json b/packages/babel-plugin-extract-messages/package.json
@@ -2,7 +2,7 @@
   "name": "@lingui/babel-plugin-extract-messages",
   "version": "3.15.0",
   "description": "Babel plugin for collecting messages from source code for internationalization",
-  "main": "index.js",
+  "main": "./build/index.js",
   "author": {
     "name": "Tomáš Ehrlich",
     "email": "tomas.ehrlich@gmail.com"
@@ -17,6 +17,11 @@
     "i9n",
     "translation"
   ],
+  "files": [
+    "LICENSE",
+    "README.md",
+    "build/"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/lingui/js-lingui.git"

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -18,20 +18,25 @@
     "name": "Tomáš Ehrlich",
     "email": "tomas.ehrlich@gmail.com"
   },
-  "main": "index.js",
+  "main": "./build/index.js",
   "bin": {
-    "lingui": "./lingui.js"
+    "lingui": "./build/lingui.js"
+  },
+  "exports": {
+    ".": {
+      "require": "./build/index.js"
+    },
+    "./api": {
+      "require": "./build/api/index.js"
+    }
   },
   "engines": {
     "node": ">=10.0.0"
   },
   "files": [
     "LICENSE",
     "README.md",
-    "api",
-    "services",
-    "lingui.js",
-    "lingui-*.js"
+    "build/"
   ],
   "dependencies": {
     "@babel/generator": "^7.11.6",

diff --git a/packages/cli/src/api/compile.ts b/packages/cli/src/api/compile.ts
@@ -1,6 +1,6 @@
 import * as t from "@babel/types"
 import generate, {GeneratorOptions} from "@babel/generator"
-import {compileMessage} from "@lingui/core"
+import {compileMessage} from "@lingui/core/compile"
 import pseudoLocalize from "./pseudoLocalize"
 
 export type CompiledCatalogNamespace = "cjs" | "es" | "ts" | string

diff --git a/packages/cli/src/api/detect.ts b/packages/cli/src/api/detect.ts
@@ -1,31 +1,43 @@
 import fs from "fs"
+import nodePath from "path"
 import pkgUp from "pkg-up"
+import cliPackageJson from "../../package.json";
 
 export const projectType = {
   CRA: "CRA",
   REACT: "REACT",
 }
 
-function getPackageJson() {
-  const packageJsonPath = pkgUp.sync()
+type PackageJson = {
+  name: string
+  dependencies: Record<string, string>
+  devDependencies: Record<string, string>
+}
+
+function getPackageJson(cwd?: string): {path: string, content: PackageJson} {
+  const packageJsonPath = pkgUp.sync({
+    cwd
+  })
 
   try {
     const json = fs.readFileSync(packageJsonPath, "utf8")
-    return JSON.parse(json)
+    return {path: packageJsonPath, content: JSON.parse(json)}
   } catch (e) {
     console.error(e)
     return null
   }
 }
 
-function hasDependency(pkg, name) {
+
+
+function hasDependency(pkg: PackageJson, name: string) {
   return (
     (pkg.dependencies && pkg.dependencies[name]) ||
     (pkg.devDependencies && pkg.devDependencies[name])
   )
 }
 
-function detectFramework(pkg) {
+function detectFramework(pkg: PackageJson) {
   if (hasDependency(pkg, "react-scripts")) {
     return projectType.CRA
   }
@@ -38,8 +50,13 @@ function detectFramework(pkg) {
 }
 
 export function detect() {
-  const pkg = getPackageJson()
+  let pkg = getPackageJson()
+
   if (!pkg) return null
 
-  return detectFramework(pkg)
+  if (pkg.content.name === cliPackageJson.name) {
+    pkg = getPackageJson(nodePath.dirname(pkg.path))
+  }
+
+  return detectFramework(pkg.content)
 }
diff --git a/packages/conf/package.json b/packages/conf/package.json
@@ -14,7 +14,7 @@
     "name": "Tomáš Ehrlich",
     "email": "tomas.ehrlich@gmail.com"
   },
-  "main": "index.js",
+  "main": "build/index.js",
   "engines": {
     "node": ">=10.0.0"
   },

diff --git a/packages/core/compile.entry.js b/packages/core/compile.entry.js
@@ -0,0 +1,4 @@
+/**
+ * this is Rollup Entry
+ */
+export * from "./src/compile"
diff --git a/packages/core/compile.js b/packages/core/compile.js
@@ -0,0 +1,5 @@
+/**
+ * this is used to point to the right source when development with workspaces
+ */
+// eslint-disable-next-line import/no-unresolved
+export * from "./build/compile"
diff --git a/packages/core/dev.js b/packages/core/dev.js
diff --git a/packages/core/formats.js b/packages/core/formats.js
diff --git a/packages/core/npm/compile.js b/packages/core/npm/compile.js
@@ -0,0 +1,5 @@
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./cjs/compile.production.min.js")
+} else {
+  module.exports = require("./cjs/compile.development.js")
+}
diff --git a/packages/core/npm/dev.js b/packages/core/npm/dev.js
diff --git a/packages/core/npm/esm/compile.js b/packages/core/npm/esm/compile.js
@@ -0,0 +1,9 @@
+import {
+    compileMessage as compileMessageProd
+} from './compile.production.min.js';
+
+import {
+    compileMessage as compileMessageDev
+} from './compile.development.js';
+
+export const compileMessage = process.env.NODE_ENV === 'production' ? compileMessageProd : compileMessageDev;
diff --git a/packages/core/npm/esm/dev.js b/packages/core/npm/esm/dev.js
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -3,9 +3,9 @@
   "version": "3.15.0",
   "sideEffects": false,
   "description": "I18n tools for javascript",
-  "main": "index.js",
-  "module": "esm/index.js",
-  "types": "cjs/index.d.ts",
+  "main": "./build/index.js",
+  "module": "./build/esm/index.js",
+  "types": "./build/cjs/index.d.ts",
   "author": {
     "name": "Tomáš Ehrlich",
     "email": "tomas.ehrlich@gmail.com"
@@ -27,21 +27,23 @@
     "url": "https://github.com/lingui/js-lingui/issues"
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=14.0.0"
   },
   "exports": {
     ".": {
-      "require": "./index.js",
-      "import": "./esm/index.js"
+      "require": "./build/index.js",
+      "import": "./build/esm/index.js"
+    },
+    "./compile": {
+      "require": "./build/compile.js",
+      "import": "./build/esm/compile.js"
     },
     "./package.json": "./package.json"
   },
   "files": [
     "LICENSE",
     "README.md",
-    "index.js",
-    "cjs/",
-    "esm/"
+    "build/"
   ],
   "dependencies": {
     "@babel/runtime": "^7.11.2",

diff --git a/packages/core/src/compileMessage.test.ts → ...s/core/src/compile/compileMessage.test.ts b/packages/core/src/compileMessage.test.ts → ...s/core/src/compile/compileMessage.test.ts
@@ -1,7 +1,7 @@
 import {compileMessage as compile} from "./compileMessage"
 import { mockEnv, mockConsole } from "@lingui/jest-mocks"
-import { interpolate } from "./context"
-import {Locale, Locales} from "./i18n"
+import { interpolate } from "../context"
+import {Locale, Locales} from "../i18n"
 
 describe("compile", () => {
   const englishPlurals = {

diff --git a/packages/core/src/compileMessage.ts → packages/core/src/compile/compileMessage.ts b/packages/core/src/compileMessage.ts → packages/core/src/compile/compileMessage.ts
@@ -1,5 +1,5 @@
 import {Content, parse, Token} from "@messageformat/parser"
-import {CompiledMessage, CompiledMessageToken} from "./i18n"
+import {CompiledMessage, CompiledMessageToken} from "../i18n"
 
 type MapTextFn =  (value: string) => string;
 
@@ -52,6 +52,7 @@ function processTokens(tokens: Array<Token>, mapText?: MapTextFn): CompiledMessa
 }
 
 // Message -> (Params -> String)
+/** @internal */
 export function compileMessage(
   message: string,
   mapText: MapTextFn = (v) => v,

diff --git a/packages/core/src/compile/index.ts b/packages/core/src/compile/index.ts
@@ -0,0 +1 @@
+export * from './compileMessage';
diff --git a/packages/core/src/dev/index.ts b/packages/core/src/dev/index.ts
diff --git a/packages/core/src/dev/loadLocaleData.test.ts b/packages/core/src/dev/loadLocaleData.test.ts
diff --git a/packages/core/src/dev/loadLocaleData.ts b/packages/core/src/dev/loadLocaleData.ts
diff --git a/packages/core/src/i18n.ts b/packages/core/src/i18n.ts
@@ -1,7 +1,7 @@
 import { interpolate, UNICODE_REGEX } from "./context"
 import { isString, isFunction } from "./essentials"
 import { date, number } from "./formats"
-import * as icu from "./dev"
+import { compileMessage } from "./compile"
 import { EventEmitter } from "./eventEmitter"
 import type {PluralCategory} from "make-plural"
 
@@ -206,7 +206,7 @@ export class I18n extends EventEmitter<Events> {
 
     if (process.env.NODE_ENV !== "production") {
       translation = isString(translation)
-        ? icu.compile(translation)
+        ? compileMessage(translation)
         : translation
     }
 

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -10,10 +10,6 @@ export {
   Locales,
 } from "./i18n"
 
-export {
-  compileMessage
-} from './compileMessage'
-
 // Default i18n object
 import { setupI18n } from "./i18n"
 export const i18n = setupI18n()