chore(scripts): replace tsc by esbuild (#3425)

Author: millotp

eslint/package.json

@@ -2,12 +2,12 @@
   "name": "eslint-plugin-automation-custom",
   "version": "1.0.0",
   "description": "Custom rules for eslint",
-  "main": "dist/src/index.js",
+  "main": "dist/index.js",
   "files": [
     "src/**.ts"
   ],
   "scripts": {
-    "build": "rm -rf dist/ && tsc",
+    "build": "esbuild --bundle --minify --platform=node --outdir=dist --log-level=error src/index.ts",
     "lint": "eslint --ext=ts .",
     "lint:fix": "eslint --ext=ts --fix .",
     "test": "jest"
@@ -17,6 +17,7 @@
     "@babel/preset-env": "7.24.8",
     "@babel/preset-typescript": "7.24.7",
     "@types/jest": "29.5.12",
+    "esbuild": "0.23.0",
     "eslint": "8.57.0",
     "jest": "29.7.0",
     "typescript": "5.5.3"

scripts/ci/actions/restore-artifacts/action.yml

@@ -11,4 +11,4 @@ inputs:
       List of languages to restore (use the pipe character to put each language on its own line)
 runs:
   using: 'node20'
-  main: './builddir/index.js'
+  main: './builddir/index.cjs'

scripts/ci/actions/restore-artifacts/builddir/index.cjs

@@ -4,9 +4,8 @@ import { setOutput } from '@actions/core';
 import { CLIENTS, createClientName, GENERATORS, LANGUAGES } from '../../common.js';
 import { getLanguageFolder, getTestExtension, getTestOutputFolder } from '../../config.js';
 
-import { COMMON_DEPENDENCIES, DEPENDENCIES } from './setRunVariables.js';
 import type { ClientMatrix, CreateMatrix, ToRunMatrix } from './types.js';
-import { isBaseChanged } from './utils.js';
+import { COMMON_DEPENDENCIES, DEPENDENCIES, isBaseChanged } from './utils.js';
 
 // This empty matrix is required by the CI, otherwise it throws
 const EMPTY_MATRIX = { client: ['no-run'] };

scripts/ci/actions/restore-artifacts/builddir/index.js

@@ -1,75 +1,7 @@
 /* eslint-disable no-console */
 import * as core from '@actions/core';
 
-import { LANGUAGES } from '../../common.js';
-import { getLanguageFolder } from '../../config.js';
-import type { Language } from '../../types.js';
-
-import { isBaseChanged } from './utils.js';
-
-export const COMMON_DEPENDENCIES = {
-  GITHUB_ACTIONS_CHANGED: ['.github/actions', '.github/workflows'],
-  SCRIPTS_CHANGED: [
-    'scripts',
-    'eslint',
-    'yarn.lock',
-    '.eslintrc.cjs',
-    'config/generation.config.mjs',
-    'config/clients.config.json',
-    'config/release.config.json',
-    'generators',
-    'tests/CTS',
-    '.nvmrc',
-  ],
-  COMMON_SPECS_CHANGED: ['specs/common'],
-};
-
-export function getVersionFileForLanguage(lang: Language): string {
-  // js rely on the nvmrc of the repo
-  if (lang === 'javascript') {
-    return '.nvmrc';
-  }
-
-  // jvm lang rely on the same java version
-  if (lang === 'kotlin' || lang === 'java' || lang === 'scala') {
-    return 'config/.java-version';
-  }
-
-  return `config/.${lang}-version`;
-}
-
-/**
- * This dependency array is generated to match the "external" dependencies of a generated client.
- *
- * Those variables are used to determine if jobs should run, based on the changes
- * made in their respective dependencies.
- *
- * Negative paths should start with `:!`.
- *
- * The variable will be accessible in the CI via `steps.diff.outputs.<name>`.
- *
- * Variables starting by `LANGUAGENAME_` will be used in the `createMatrix` to determine
- * if a job should be added.
- */
-export const DEPENDENCIES = LANGUAGES.reduce(
-  (finalDependencies, lang) => {
-    const key = `${lang.toUpperCase()}_CLIENT_CHANGED`;
-    const langFolder = getLanguageFolder(lang);
-
-    finalDependencies[key] = [
-      ':!**node_modules',
-      `templates/${lang}`,
-      // language related files
-      langFolder,
-      getVersionFileForLanguage(lang),
-      `:!${langFolder}/.github`,
-      `:!${langFolder}/README.md`,
-    ];
-
-    return finalDependencies;
-  },
-  { ...COMMON_DEPENDENCIES } as Record<string, string[]>,
-);
+import { DEPENDENCIES, isBaseChanged } from './utils.js';
 
 /**
  * Outputs variables used in the CI to determine if a job should run.

scripts/ci/actions/restore-artifacts/builddir/index.js.map

@@ -1,8 +1,75 @@
 /* eslint-disable no-console */
 import * as core from '@actions/core';
 
+import { LANGUAGES } from '../../common.js';
+import { getLanguageFolder } from '../../config.js';
+import type { Language } from '../../types.js';
 import { getNbGitDiff } from '../utils.js';
 
+export const COMMON_DEPENDENCIES = {
+  GITHUB_ACTIONS_CHANGED: ['.github/actions', '.github/workflows'],
+  SCRIPTS_CHANGED: [
+    'scripts',
+    'eslint',
+    'yarn.lock',
+    '.eslintrc.cjs',
+    'config/generation.config.mjs',
+    'config/clients.config.json',
+    'config/release.config.json',
+    'generators',
+    'tests/CTS',
+    '.nvmrc',
+  ],
+  COMMON_SPECS_CHANGED: ['specs/common'],
+};
+
+/**
+ * This dependency array is generated to match the "external" dependencies of a generated client.
+ *
+ * Those variables are used to determine if jobs should run, based on the changes
+ * made in their respective dependencies.
+ *
+ * Negative paths should start with `:!`.
+ *
+ * The variable will be accessible in the CI via `steps.diff.outputs.<name>`.
+ *
+ * Variables starting by `LANGUAGENAME_` will be used in the `createMatrix` to determine
+ * if a job should be added.
+ */
+export const DEPENDENCIES = LANGUAGES.reduce(
+  (finalDependencies, lang) => {
+    const key = `${lang.toUpperCase()}_CLIENT_CHANGED`;
+    const langFolder = getLanguageFolder(lang);
+
+    finalDependencies[key] = [
+      ':!**node_modules',
+      `templates/${lang}`,
+      // language related files
+      langFolder,
+      getVersionFileForLanguage(lang),
+      `:!${langFolder}/.github`,
+      `:!${langFolder}/README.md`,
+    ];
+
+    return finalDependencies;
+  },
+  { ...COMMON_DEPENDENCIES } as Record<string, string[]>,
+);
+
+function getVersionFileForLanguage(lang: Language): string {
+  // js rely on the nvmrc of the repo
+  if (lang === 'javascript') {
+    return '.nvmrc';
+  }
+
+  // jvm lang rely on the same java version
+  if (lang === 'kotlin' || lang === 'java' || lang === 'scala') {
+    return 'config/.java-version';
+  }
+
+  return `config/.${lang}-version`;
+}
+
 /**
  * Determines if changes have been found in the `dependencies`, compared to the `baseBranch`.
  *

scripts/ci/actions/restore-artifacts/builddir/package.json

@@ -12,15 +12,11 @@
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null && pwd)"
 
 apic() {
-  (cd $ROOT/scripts && NODE_NO_WARNINGS=1 node dist/scripts/cli/index.js $*)
-}
-
-apicb() {
-  (cd $ROOT/scripts && yarn build:cli && NODE_NO_WARNINGS=1 node dist/scripts/cli/index.js $*)
+  # this is the same as `yarn build:cli && yarn start` but without the overhead of yarn
+  (cd $ROOT/scripts && cd $ROOT/scripts && cat package.json | jq  '.scripts."build:cli"' | xargs -I{} sh -c "eval '../node_modules/.bin/{}'" && NODE_NO_WARNINGS=1 node --enable-source-maps dist/cli/index.js $* || true)
 }
 
 export apic
-export apicb
 
 _list_languages() {
   cat $ROOT/config/clients.config.json | jq -r 'keys[]'
@@ -112,4 +108,3 @@ _apic_complete() {
 }
 
 complete -F _apic_complete apic
-complete -F _apic_complete apicb

scripts/ci/actions/restore-artifacts/builddir/sourcemap-register.cjs

@@ -4,19 +4,20 @@
   "type": "module",
   "scripts": {
     "build": "yarn build:cli & yarn build:actions",
-    "build:actions": "cd ci/actions/restore-artifacts && ncc build src/index.ts --source-map --transpile-only --minify -o builddir",
-    "build:cli": "tsc && tsc-alias",
-    "createMatrix": "NODE_NO_WARNINGS=1 node dist/scripts/ci/githubActions/createMatrix.js",
+    "build:actions": "cd ci/actions/restore-artifacts && esbuild --bundle --format=cjs --minify --platform=node --outfile=builddir/index.cjs --log-level=error src/index.ts",
+    "build:cli": "esbuild --bundle --format=esm --sourcemap --platform=node --packages=external --outdir=dist --log-level=error cli/index.ts ci/codegen/*.ts ci/githubActions/*.ts",
+    "createMatrix": "yarn runScript dist/ci/githubActions/createMatrix.js",
     "lint": "eslint --ext=ts,js,mjs,cjs .",
     "lint:deadcode": "knip",
     "pre-commit": "node ./ci/husky/pre-commit.mjs",
-    "pushGeneratedCode": "NODE_NO_WARNINGS=1 node dist/scripts/ci/codegen/pushGeneratedCode.js",
-    "pushToAlgoliaDoc": "NODE_NO_WARNINGS=1 node dist/scripts/ci/codegen/pushToAlgoliaDoc.js",
-    "setRunVariables": "NODE_NO_WARNINGS=1 node dist/scripts/ci/githubActions/setRunVariables.js",
-    "spreadGeneration": "NODE_NO_WARNINGS=1 node dist/scripts/ci/codegen/spreadGeneration.js",
-    "start": "NODE_NO_WARNINGS=1 node dist/scripts/cli/index.js",
+    "pushGeneratedCode": "yarn runScript dist/ci/codegen/pushGeneratedCode.js",
+    "pushToAlgoliaDoc": "yarn runScript dist/ci/codegen/pushToAlgoliaDoc.js",
+    "runScript": "NODE_NO_WARNINGS=1 node --enable-source-maps",
+    "setRunVariables": "yarn runScript dist/ci/githubActions/setRunVariables.js",
+    "spreadGeneration": "yarn runScript dist/ci/codegen/spreadGeneration.js",
+    "start": "yarn runScript dist/cli/index.js",
     "test": "vitest",
-    "waitForAllReleases": "NODE_NO_WARNINGS=1 node dist/scripts/ci/codegen/waitForAllReleases.js"
+    "waitForAllReleases": "yarn runScript dist/ci/codegen/waitForAllReleases.js"
   },
   "devDependencies": {
     "@actions/artifact": "2.1.8",
@@ -33,12 +34,12 @@
     "@types/node": "20.14.11",
     "@types/semver": "7.5.8",
     "@types/spinnies": "0.5.3",
-    "@vercel/ncc": "0.38.1",
     "chai": "5.1.1",
     "chalk": "5.3.0",
     "commander": "12.1.0",
     "crc": "4.3.2",
     "dotenv": "16.4.5",
+    "esbuild": "0.23.0",
     "eslint": "8.57.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-import": "2.29.1",
@@ -51,7 +52,6 @@
     "micromatch": "4.0.7",
     "semver": "7.6.3",
     "spinnies": "0.5.1",
-    "tsc-alias": "1.8.10",
     "typescript": "5.5.3",
     "vitest": "2.0.3"
   }

scripts/ci/githubActions/createMatrix.ts

@@ -8,15 +8,6 @@
     "lib": ["esnext", "dom"],
     "outDir": "dist"
   },
-  "tsc-alias": {
-    "resolveFullPaths": true,
-    "replacers": {
-      "configReplacer": {
-        "enabled": true,
-        "file": "configReplacer.cjs"
-      }
-    }
-  },
   "include": ["**/*.ts", "./**.cjs", "**/*.mjs"],
   "exclude": ["dist", "*.json", "node_modules", "**/*.test.ts"]
 }