Use an internal node build rig for internal, non-cyclic projects.

Author: iclanton

README.md

@@ -179,6 +179,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/repo-scripts/doc-plugin-rush-stack](./repo-scripts/doc-plugin-rush-stack/) | API Documenter plugin used with the rushstack.io website |
 | [/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 |
+| [/rigs/local-node-rig](./rigs/local-node-rig/) | A rig package for Node.js projects that build using Heft inside the RushStack repository. |
 | [/rush-plugins/rush-litewatch-plugin](./rush-plugins/rush-litewatch-plugin/) | An experimental alternative approach for multi-project watch mode |
 | [/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 |

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

@@ -1,3 +1,3 @@
 {
-  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+  "extends": "local-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": "local-node-rig"
 }

apps/api-documenter/package.json

@@ -31,9 +31,8 @@
   "devDependencies": {
     "@rushstack/eslint-config": "workspace:*",
     "@rushstack/heft": "workspace:*",
-    "@rushstack/heft-node-rig": "workspace:*",
+    "local-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/local-node-rig/profiles/default/tsconfig-base.json"
 }

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": "local-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": "local-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": "local-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:*",
+    "local-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