refactor(tooling 🔧): migrate from Lerna to Nx

.github/workflows/build.yaml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x, 22.x]
+        node-version: [18.x, 20.x, 22.x]
         operating-system: [windows-latest, macOS-latest, ubuntu-latest]
 
     steps:
@@ -22,6 +22,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix['node-version'] }}
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm install

.github/workflows/commitlint.yaml

@@ -18,9 +18,10 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '20'
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm install
 
       - name: Validate all commits from PR
-        run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose
+        run: npx commitlint --config config/commitlint.config.mjs --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

.github/workflows/documentation.yml

@@ -15,10 +15,11 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: '20.x'
+          cache: 'npm'
       - name: Test Build
         run: |
           npm install
-          npm run api
+          npm run api:all
           npm run docs
           cd website
           npm install
@@ -32,6 +33,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '20.x'
+          cache: 'npm'
       - name: Add key to allow access to repository
         env:
           SSH_AUTH_SOCK: /tmp/ssh_agent.sock
@@ -53,7 +55,7 @@ jobs:
           git config --global user.email "actions@gihub.com"
           git config --global user.name "gh-actions"
           npm install
-          npm run api
+          npm run api:all
           npm run docs
           cd website
           npm install

.gitignore

@@ -3,6 +3,7 @@ dist
 node_modules
 reports
 lerna-debug.log
+fixtures
 *.tsbuildinfo
 *.vsix
 goldens/models
@@ -16,3 +17,8 @@ betterer.*.log
 .betterer.cache
 .betterer.*.mjs
 .eslintcache
+
+
+
+.nx/cache
+.nx/workspace-data

.husky/commit-msg

@@ -1 +1 @@
-npx --no -- commitlint --edit $1
+npx --no -- commitlint --config config/commitlint.config.mjs --edit $1

.husky/pre-commit

@@ -1,6 +1 @@
-npm install
-npx lint-staged
-npm run test:api
-npm run test:dependencies
-npm run test:e2e
-npm run betterer:precommit
+npx lint-staged --config config/lint-staged.config.mjs

.prettierignore

@@ -4,10 +4,10 @@
 .husky
 .gitattributes
 .gitignore
-.lintstagedrc
 .npmrc
 .prettierignore
 .vscode-test
+.nx
 CHANGELOG.md
 dist
 fixtures

.betterer.ts → config/.betterer.ts

@@ -6,7 +6,7 @@ export default {
     regexp(/(\/\/\s*HACK)/i).include(['./packages/**/src/**/*.ts', './packages/**/src/**/*.tsx']),
   'no knip errors': () =>
     knip(
-      './knip.json',
+      './config/knip.json',
       {},
       {
         production: true,

api-extractor.json → config/api-extractor.json

@@ -5,13 +5,13 @@
   "apiReport": {
     "enabled": true,
     "reportFileName": "<unscopedPackageName>.api.md",
-    "reportFolder": "./goldens/api/",
-    "reportTempFolder": "./goldens/temp/"
+    "reportFolder": "../goldens/api/",
+    "reportTempFolder": "../goldens/temp/"
   },
 
   "docModel": {
     "enabled": true,
-    "apiJsonFilePath": "./goldens/models/<unscopedPackageName>.api.json"
+    "apiJsonFilePath": "../goldens/models/<unscopedPackageName>.api.json"
   },
 
   "dtsRollup": {
@@ -29,6 +29,10 @@
       "default": {
         "logLevel": "warning",
         "addToApiReportFile": true
+      },
+      "ae-internal-missing-underscore": {
+        "logLevel": "none",
+        "addToApiReportFile": false
       }
     },
     "tsdocMessageReporting": {

config/lint-staged.config.mjs

@@ -0,0 +1,5 @@
+export default {
+  '*.{ts,tsx}': () => ['npm run compile:all', 'npm run api:all'],
+  '*.{ts,tsx,js,mjs}': 'eslint --fix',
+  '*': 'prettier --write'
+};

config/tsconfig.eslint.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["../**/*.js", "../**/*.mjs", "../**/*.ts", "../**/*.tsx", "../*.js", "../*.ts", ".betterer.ts"]
+}

tsconfig.spec.json → config/tsconfig.spec.json

@@ -1,5 +1,5 @@
 {
-  "extends": "./tsconfig.json",
+  "extends": "../tsconfig.json",
   "compilerOptions": {
     "allowJs": true,
     "paths": {

vitest.e2e.config.ts → config/vitest.e2e.config.ts

@@ -1,6 +1,6 @@
 import { defineConfig } from 'vitest/config';
 
-import config from './vitest.config.js';
+import config from '../vitest.config.js';
 
 export default defineConfig({
   test: {

eslint.config.js

@@ -16,7 +16,7 @@ const compat = new FlatCompat({
 });
 
 export default tsLint.config(
-  { files: ['packages/**/src/**/*.{ts,tsx}', 'test/**/*.{ts,tsx}', '*.{ts}'] },
+  { files: ['packages/**/src/**/*.{ts,tsx}', 'test/**/*.{ts,tsx}', 'tools/**/src/**/*.ts', '*.{ts}'] },
   {
     ignores: ['**/node_modules/**', '**/dist/**', 'fixtures/**', 'reports/**', 'website/**', '**/.vscode-test/**']
   },
@@ -35,7 +35,7 @@ export default tsLint.config(
     languageOptions: {
       globals: globals.browser,
       parserOptions: {
-        project: './tsconfig.eslint.json',
+        project: './config/tsconfig.eslint.json',
         tsconfigRootDir: dirname
       }
     }

nx.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "./node_modules/nx/schemas/nx-schema.json",
+  "targetDefaults": {
+    "compile": {
+      "dependsOn": ["^compile"],
+      "outputs": ["{projectRoot}/dist"],
+      "cache": true
+    },
+    "lint": {
+      "options": {
+        "command": "eslint --cache ."
+      }
+    }
+  },
+  "defaultBase": "master",
+  "release": {
+    "projects": ["packages/*", "!packages/extension", "!packages/fixture", "!packages/docgen"],
+    "projectsRelationship": "fixed",
+    "version": {
+      "conventionalCommits": true,
+      "preVersionCommand": "nx run-many -t sync:metadata"
+    },
+    "changelog": {
+      "workspaceChangelog": true,
+      "projectChangelogs": false
+    },
+    "git": {
+      "commit": true,
+      "commitMessage": "chore(release 🔖): publish {version}",
+      "tag": true
+    }
+  },
+  "plugins": [
+    {
+      "plugin": "./tools/nx-plugin-betterer-monorepo-api/src/index.ts"
+    },
+    {
+      "plugin": "./tools/nx-plugin-betterer-monorepo-clean/src/index.ts"
+    },
+    {
+      "plugin": "./tools/nx-plugin-betterer-monorepo-metadata/src/index.ts"
+    },
+    {
+      "plugin": "./tools/nx-plugin-betterer-monorepo-docs/src/index.ts"
+    },
+    {
+      "plugin": "@nx/js/typescript",
+      "options": {
+        "typecheck": {
+          "targetName": "typecheck"
+        }
+      }
+    },
+    {
+      "plugin": "@nx/eslint/plugin",
+      "options": {
+        "targetName": "lint"
+      }
+    },
+    {
+      "plugin": "@nx/vite/plugin",
+      "options": {
+        "testTargetName": "test",
+        "typecheckTargetName": "typecheck"
+      }
+    }
+  ],
+  "analytics": false
+}