Merge pull request microsoft#3944 from iclanton/internal-node-rig

Use an internal node build rig for internal, non-cyclic projects and fix caching across the repo.

README.md

@@ -180,6 +180,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/repo-scripts/generate-api-docs](./repo-scripts/generate-api-docs/) | Used to generate API docs for the rushstack.io website |
 | [/repo-scripts/repo-toolbox](./repo-scripts/repo-toolbox/) | Used to execute various operations specific to this repo |
 | [/rush-plugins/rush-litewatch-plugin](./rush-plugins/rush-litewatch-plugin/) | An experimental alternative approach for multi-project watch mode |
+| [/rushstack-internal-rigs/heft-rushstack-internal-node-rig](./rushstack-internal-rigs/heft-rushstack-internal-node-rig/) | A rig package for Node.js projects that build using Heft inside the RushStack repository. |
 | [/vscode-extensions/rush-vscode-command-webview](./vscode-extensions/rush-vscode-command-webview/) | Part of the Rush Stack VSCode extension, provides a UI for invoking Rush commands |
 | [/vscode-extensions/rush-vscode-extension](./vscode-extensions/rush-vscode-extension/) | Enhanced experience for monorepos that use the Rush Stack toolchain |
 | [/webpack/webpack-deep-imports-plugin](./webpack/webpack-deep-imports-plugin/) | This plugin creates a bundle and commonJS files in a 'lib' folder mirroring modules in another 'lib' folder. |

apps/api-documenter/config/jest.config.json

@@ -1,3 +1,3 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "heft-rushstack-internal-node-rig/profiles/default/config/jest.config.json"
 }

apps/api-documenter/config/rig.json

@@ -3,5 +3,5 @@
   // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
   "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
 
-  "rigPackageName": "@rushstack/heft-node-rig"
+  "rigPackageName": "heft-rushstack-internal-node-rig"
 }

apps/api-documenter/package.json

@@ -31,9 +31,8 @@
   "devDependencies": {
     "@rushstack/eslint-config": "workspace:*",
     "@rushstack/heft": "workspace:*",
-    "@rushstack/heft-node-rig": "workspace:*",
+    "heft-rushstack-internal-node-rig": "workspace:*",
     "@types/js-yaml": "3.12.1",
-    "@types/node": "18.17.15",
     "@types/resolve": "1.20.2"
   }
 }

apps/api-documenter/tsconfig.json

@@ -1,6 +1,3 @@
 {
-  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
-  "compilerOptions": {
-    "resolveJsonModule": true
-  }
+  "extends": "./node_modules/heft-rushstack-internal-node-rig/profiles/default/tsconfig-base.json"
 }

apps/api-extractor/config/jest.config.json

@@ -1,3 +1,11 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json",
+
+  // Enable code coverage for Jest
+  "collectCoverage": true,
+  "coverageDirectory": "<rootDir>/coverage",
+  "coverageReporters": ["cobertura", "html"],
+
+  // Use v8 coverage provider to avoid Babel
+  "coverageProvider": "v8"
 }

apps/api-extractor/config/rush-project.json

@@ -0,0 +1,14 @@
+{
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/rush-project.json",
+
+  "operationSettings": [
+    {
+      "operationName": "_phase:build",
+      "outputFolderNames": [".heft", "release"]
+    },
+    {
+      "operationName": "_phase:test",
+      "outputFolderNames": ["coverage"]
+    }
+  ]
+}

apps/heft/config/jest.config.json

@@ -1,3 +1,11 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json",
+
+  // Enable code coverage for Jest
+  "collectCoverage": true,
+  "coverageDirectory": "<rootDir>/coverage",
+  "coverageReporters": ["cobertura", "html"],
+
+  // Use v8 coverage provider to avoid Babel
+  "coverageProvider": "v8"
 }

apps/heft/config/rush-project.json

@@ -0,0 +1,14 @@
+{
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/rush-project.json",
+
+  "operationSettings": [
+    {
+      "operationName": "_phase:build",
+      "outputFolderNames": [".heft", "release"]
+    },
+    {
+      "operationName": "_phase:test",
+      "outputFolderNames": ["coverage"]
+    }
+  ]
+}

apps/lockfile-explorer-web/config/jest.config.json

@@ -1,6 +1,14 @@
 {
   "extends": "@rushstack/heft-web-rig/profiles/app/config/jest.config.json",
 
+  // Enable code coverage for Jest
+  "collectCoverage": true,
+  "coverageDirectory": "<rootDir>/coverage",
+  "coverageReporters": ["cobertura", "html"],
+
+  // Use v8 coverage provider to avoid Babel
+  "coverageProvider": "v8",
+
   // Load the initappcontext.js stub when running tests
   "setupFiles": ["../lib-commonjs/stub/initappcontext.js"]
 }

apps/lockfile-explorer-web/config/rush-project.json

@@ -0,0 +1,14 @@
+{
+  "extends": "@rushstack/heft-web-rig/profiles/app/config/rush-project.json",
+
+  "operationSettings": [
+    {
+      "operationName": "_phase:build",
+      "outputFolderNames": [".heft", "release"]
+    },
+    {
+      "operationName": "_phase:test",
+      "outputFolderNames": ["coverage"]
+    }
+  ]
+}

apps/lockfile-explorer/config/heft.json

@@ -8,7 +8,7 @@
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
    */
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/heft.json",
+  "extends": "heft-rushstack-internal-node-rig/profiles/default/config/heft.json",
 
   "phasesByName": {
     "build": {

apps/lockfile-explorer/config/jest.config.json

@@ -1,3 +1,3 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "heft-rushstack-internal-node-rig/profiles/default/config/jest.config.json"
 }

apps/lockfile-explorer/config/rig.json

@@ -7,7 +7,7 @@
    * (Required) The name of the rig package to inherit from.
    * It should be an NPM package name with the "-rig" suffix.
    */
-  "rigPackageName": "@rushstack/heft-node-rig"
+  "rigPackageName": "heft-rushstack-internal-node-rig"
 
   /**
    * (Optional) Selects a config profile from the rig package.  The name must consist of

apps/lockfile-explorer/package.json

@@ -39,14 +39,12 @@
   "devDependencies": {
     "@microsoft/rush-lib": "workspace:*",
     "@rushstack/eslint-config": "workspace:*",
-    "@rushstack/heft-node-rig": "workspace:*",
+    "heft-rushstack-internal-node-rig": "workspace:*",
     "@rushstack/heft": "workspace:*",
     "@rushstack/lockfile-explorer-web": "workspace:*",
     "@types/cors": "~2.8.12",
     "@types/express": "4.17.13",
-    "@types/heft-jest": "1.0.1",
     "@types/js-yaml": "3.12.1",
-    "@types/node": "18.17.15",
     "@types/update-notifier": "~6.0.1"
   },
   "dependencies": {

apps/lockfile-explorer/src/start.ts

@@ -10,21 +10,21 @@ import open from 'open';
 import updateNotifier from 'update-notifier';
 import { FileSystem, type IPackageJson, JsonFile, PackageJsonLookup } from '@rushstack/node-core-library';
 import type { IAppContext } from '@rushstack/lockfile-explorer-web/lib/AppContext';
-import packageJSON from '../package.json';
 import { init } from './init';
 import type { IAppState } from './state';
 import { AlreadyReportedError } from '@rushstack/node-core-library';
 
 function startApp(debugMode: boolean): void {
   const lockfileExplorerProjectRoot: string = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname)!;
-  const appVersion: string = JsonFile.load(`${lockfileExplorerProjectRoot}/package.json`).version;
+  const packageJson: IPackageJson = JsonFile.load(`${lockfileExplorerProjectRoot}/package.json`);
+  const appVersion: string = packageJson.version;
 
   console.log(
     colors.bold(`\nRush Lockfile Explorer ${appVersion}`) + colors.cyan(' - https://lfx.rushstack.io/\n')
   );
 
   updateNotifier({
-    pkg: packageJSON,
+    pkg: packageJson,
     // Normally update-notifier waits a day or so before it starts displaying upgrade notices.
     // In debug mode, show the notice right away.
     updateCheckInterval: debugMode ? 0 : undefined

apps/lockfile-explorer/tsconfig.json

@@ -1,6 +1,3 @@
 {
-  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
-  "compilerOptions": {
-    "types": ["heft-jest", "node"]
-  }
+  "extends": "./node_modules/heft-rushstack-internal-node-rig/profiles/default/tsconfig-base.json"
 }

apps/rundown/config/rig.json

@@ -3,5 +3,5 @@
   // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
   "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
 
-  "rigPackageName": "@rushstack/heft-node-rig"
+  "rigPackageName": "heft-rushstack-internal-node-rig"
 }

apps/rundown/package.json

@@ -28,8 +28,6 @@
   "devDependencies": {
     "@rushstack/eslint-config": "workspace:*",
     "@rushstack/heft": "workspace:*",
-    "@rushstack/heft-node-rig": "workspace:*",
-    "@types/heft-jest": "1.0.1",
-    "@types/node": "18.17.15"
+    "heft-rushstack-internal-node-rig": "workspace:*"
   }
 }

apps/rundown/tsconfig.json

@@ -1,6 +1,3 @@
 {
-  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
-  "compilerOptions": {
-    "types": ["heft-jest", "node"]
-  }
+  "extends": "./node_modules/heft-rushstack-internal-node-rig/profiles/default/tsconfig-base.json"
 }

apps/rush/config/jest.config.json

@@ -1,3 +1,3 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "heft-rushstack-internal-node-rig/profiles/default/config/jest.config.json"
 }

apps/rush/config/rig.json

@@ -3,5 +3,5 @@
   // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
   "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
 
-  "rigPackageName": "@rushstack/heft-node-rig"
+  "rigPackageName": "heft-rushstack-internal-node-rig"
 }

apps/rush/package.json

@@ -44,12 +44,11 @@
   "devDependencies": {
     "@rushstack/eslint-config": "workspace:*",
     "@rushstack/heft": "workspace:*",
-    "@rushstack/heft-node-rig": "workspace:*",
+    "heft-rushstack-internal-node-rig": "workspace:*",
     "@rushstack/rush-amazon-s3-build-cache-plugin": "workspace:*",
     "@rushstack/rush-azure-storage-build-cache-plugin": "workspace:*",
     "@rushstack/rush-http-build-cache-plugin": "workspace:*",
     "@types/heft-jest": "1.0.1",
-    "@types/node": "18.17.15",
     "@types/semver": "7.5.0"
   }
 }

apps/rush/tsconfig.json

@@ -1,6 +1,3 @@
 {
-  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
-  "compilerOptions": {
-    "types": ["heft-jest", "node"]
-  }
+  "extends": "./node_modules/heft-rushstack-internal-node-rig/profiles/default/tsconfig-base.json"
 }

apps/trace-import/config/jest.config.json

@@ -1,3 +1,3 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "heft-rushstack-internal-node-rig/profiles/default/config/jest.config.json"
 }

apps/trace-import/config/rig.json

@@ -3,5 +3,5 @@
   // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
   "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
 
-  "rigPackageName": "@rushstack/heft-node-rig"
+  "rigPackageName": "heft-rushstack-internal-node-rig"
 }

apps/trace-import/package.json

@@ -28,9 +28,7 @@
   "devDependencies": {
     "@rushstack/eslint-config": "workspace:*",
     "@rushstack/heft": "workspace:*",
-    "@rushstack/heft-node-rig": "workspace:*",
-    "@types/heft-jest": "1.0.1",
-    "@types/node": "18.17.15",
+    "heft-rushstack-internal-node-rig": "workspace:*",
     "@types/resolve": "1.20.2",
     "@types/semver": "7.5.0"
   }

apps/trace-import/tsconfig.json

@@ -1,7 +1,3 @@
 {
-  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
-
-  "compilerOptions": {
-    "types": ["heft-jest", "node"]
-  }
+  "extends": "./node_modules/heft-rushstack-internal-node-rig/profiles/default/tsconfig-base.json"
 }

build-tests-samples/heft-node-basic-tutorial/config/jest.config.json

@@ -1,3 +1,13 @@
 {
-  "extends": "@rushstack/heft-jest-plugin/includes/jest-shared.config.json"
+  "extends": "@rushstack/heft-jest-plugin/includes/jest-shared.config.json",
+
+  // These additional properties exist for caching purposes in the rushstack repo
+
+  // Enable code coverage for Jest
+  "collectCoverage": true,
+  "coverageDirectory": "<rootDir>/coverage",
+  "coverageReporters": ["cobertura", "html"],
+
+  // Use v8 coverage provider to avoid Babel
+  "coverageProvider": "v8"
 }

build-tests-samples/heft-node-basic-tutorial/config/rush-project.json

@@ -1,10 +1,15 @@
+// This file exists for caching purposes in the rushstack repo
 {
   "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush-project.schema.json",
 
   "operationSettings": [
     {
-      "operationName": "build",
-      "outputFolderNames": ["lib", "dist"]
+      "operationName": "_phase:build",
+      "outputFolderNames": [".heft", "lib", "dist"]
+    },
+    {
+      "operationName": "_phase:test",
+      "outputFolderNames": ["coverage"]
     }
   ]
 }

build-tests-samples/heft-node-jest-tutorial/config/jest.config.json

@@ -1,12 +1,22 @@
 {
   "extends": "@rushstack/heft-jest-plugin/includes/jest-shared.config.json",
-  "collectCoverage": true,
+
   "coverageThreshold": {
     "global": {
       "branches": 50,
       "functions": 50,
       "lines": 50,
       "statements": 50
     }
-  }
+  },
+
+  // These additional properties exist for caching purposes in the rushstack repo
+
+  // Enable code coverage for Jest
+  "collectCoverage": true,
+  "coverageDirectory": "<rootDir>/coverage",
+  "coverageReporters": ["cobertura", "html"],
+
+  // Use v8 coverage provider to avoid Babel
+  "coverageProvider": "v8"
 }

build-tests-samples/heft-node-jest-tutorial/config/rush-project.json

@@ -1,10 +1,15 @@
+// This file exists for caching purposes in the rushstack repo
 {
   "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush-project.schema.json",
 
   "operationSettings": [
     {
-      "operationName": "build",
-      "outputFolderNames": ["lib", "dist"]
+      "operationName": "_phase:build",
+      "outputFolderNames": [".heft", "lib", "dist"]
+    },
+    {
+      "operationName": "_phase:test",
+      "outputFolderNames": ["coverage"]
     }
   ]
 }

build-tests-samples/heft-node-rig-tutorial/config/jest.config.json

@@ -1,3 +1,13 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json",
+
+  // These additional properties exist for caching purposes in the rushstack repo
+
+  // Enable code coverage for Jest
+  "collectCoverage": true,
+  "coverageDirectory": "<rootDir>/coverage",
+  "coverageReporters": ["cobertura", "html"],
+
+  // Use v8 coverage provider to avoid Babel
+  "coverageProvider": "v8"
 }

build-tests-samples/heft-node-rig-tutorial/config/rush-project.json

@@ -0,0 +1,15 @@
+// This file exists for caching purposes in the rushstack repo
+{
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/rush-project.json",
+
+  "operationSettings": [
+    {
+      "operationName": "_phase:build",
+      "outputFolderNames": [".heft", "release"]
+    },
+    {
+      "operationName": "_phase:test",
+      "outputFolderNames": ["coverage"]
+    }
+  ]
+}