[rush-build-graph-plugin] Add plugin for generating a build graph file for the given command

README.md

@@ -94,6 +94,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/rigs/heft-web-rig](./rigs/heft-web-rig/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Fheft-web-rig.svg)](https://badge.fury.io/js/%40rushstack%2Fheft-web-rig) | [changelog](./rigs/heft-web-rig/CHANGELOG.md) | [@rushstack/heft-web-rig](https://www.npmjs.com/package/@rushstack/heft-web-rig) |
 | [/rush-plugins/rush-amazon-s3-build-cache-plugin](./rush-plugins/rush-amazon-s3-build-cache-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Frush-amazon-s3-build-cache-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Frush-amazon-s3-build-cache-plugin) | | [@rushstack/rush-amazon-s3-build-cache-plugin](https://www.npmjs.com/package/@rushstack/rush-amazon-s3-build-cache-plugin) |
 | [/rush-plugins/rush-azure-storage-build-cache-plugin](./rush-plugins/rush-azure-storage-build-cache-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Frush-azure-storage-build-cache-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Frush-azure-storage-build-cache-plugin) | | [@rushstack/rush-azure-storage-build-cache-plugin](https://www.npmjs.com/package/@rushstack/rush-azure-storage-build-cache-plugin) |
+| [/rush-plugins/rush-build-graph-plugin](./rush-plugins/rush-build-graph-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Frush-build-graph-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Frush-build-graph-plugin) | | [@rushstack/rush-build-graph-plugin](https://www.npmjs.com/package/@rushstack/rush-build-graph-plugin) |
 | [/rush-plugins/rush-http-build-cache-plugin](./rush-plugins/rush-http-build-cache-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Frush-http-build-cache-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Frush-http-build-cache-plugin) | | [@rushstack/rush-http-build-cache-plugin](https://www.npmjs.com/package/@rushstack/rush-http-build-cache-plugin) |
 | [/rush-plugins/rush-redis-cobuild-plugin](./rush-plugins/rush-redis-cobuild-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Frush-redis-cobuild-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Frush-redis-cobuild-plugin) | | [@rushstack/rush-redis-cobuild-plugin](https://www.npmjs.com/package/@rushstack/rush-redis-cobuild-plugin) |
 | [/rush-plugins/rush-serve-plugin](./rush-plugins/rush-serve-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Frush-serve-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Frush-serve-plugin) | | [@rushstack/rush-serve-plugin](https://www.npmjs.com/package/@rushstack/rush-serve-plugin) |

common/changes/@microsoft/rush/user-bpapp-ms-add-graph-plugin_2024-04-08-23-25.json

@@ -0,0 +1,10 @@
+{
+ "changes": [
+ {
+ "packageName": "@microsoft/rush",
+ "comment": "Introduce the `@rushstack/rush-build-graph-plugin` plugin.",
+ "type": "none"
+ }
+ ],
+ "packageName": "@microsoft/rush"
+}

common/reviews/api/rush-build-graph-plugin.api.md

@@ -0,0 +1,38 @@
+## API Report File for "@rushstack/rush-build-graph-plugin"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { IRushPlugin } from '@rushstack/rush-sdk';
+import type { RushConfiguration } from '@rushstack/rush-sdk';
+import type { RushSession } from '@rushstack/rush-sdk';
+
+// @beta
+class DropBuildGraphPlugin implements IRushPlugin {
+ // (undocumented)
+ apply(session: RushSession, configuration: RushConfiguration): void;
+}
+export default DropBuildGraphPlugin;
+
+// @beta
+export interface IBuildXLRushGraph {
+ nodes: IGraphNode[];
+ repoSettings: {
+ commonTempFolder: string;
+ };
+}
+
+// @beta
+export interface IGraphNode {
+ command: string;
+ dependencies: string[];
+ id: string;
+ package: string;
+ task: string;
+ workingDirectory: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

rush-plugins/rush-build-graph-plugin/.eslintrc.js

@@ -0,0 +1,12 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('local-node-rig/profiles/default/includes/eslint/patch/modern-module-resolution');
+// This is a workaround for https://github.com/microsoft/rushstack/issues/3021
+require('local-node-rig/profiles/default/includes/eslint/patch/custom-config-package-names');
+
+module.exports = {
+ extends: [
+ 'local-node-rig/profiles/default/includes/eslint/profile/node-trusted-tool',
+ 'local-node-rig/profiles/default/includes/eslint/mixins/friendly-locals'
+ ],
+ parserOptions: { tsconfigRootDir: __dirname }
+};

rush-plugins/rush-build-graph-plugin/.gitignore

@@ -0,0 +1 @@
+tsdoc-metadata.json

rush-plugins/rush-build-graph-plugin/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/rush-build-graph-plugin
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

rush-plugins/rush-build-graph-plugin/README.md

@@ -0,0 +1,8 @@
+## Overview
+This plugin is used to create json files representing the build graph of a rush action. When used, it only runs through the process of generating Rush's version of the graph, which is then processed and dropped as a file before exiting the process.
+
+## Usage
+The plugin is invoked via the `--drop-graph [file]` parameter to rush, which says to run the command as otherwise given, but to drop the graph to the given file and exit before executing the build tasks. The graph is represented as a json object which can be seen under `examples/graph.json`.
+
+## Limitations
+It currently only supports shell operations, which is to say that the only supported runner to be passed in from Rush is the ShellOperationRunner.

rush-plugins/rush-build-graph-plugin/config/api-extractor.json

@@ -0,0 +1,16 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+ "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+ "apiReport": {
+ "enabled": true,
+ "reportFolder": "../../../common/reviews/api"
+ },
+ "docModel": {
+ "enabled": false
+ },
+ "dtsRollup": {
+ "enabled": true,
+ "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+ }
+}

rush-plugins/rush-build-graph-plugin/config/heft.json

@@ -0,0 +1,44 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json",
+
+ "extends": "local-node-rig/profiles/default/config/heft.json",
+
+ "phasesByName": {
+ "build": {
+ "tasksByName": {
+ "copy-rush-build-graph-plugin": {
+ "taskDependencies": ["typescript"],
+ "taskPlugin": {
+ "pluginPackage": "@rushstack/heft",
+ "pluginName": "copy-files-plugin",
+ "options": {
+ "copyOperations": [
+ {
+ "sourcePath": "lib",
+ "destinationFolders": [
+ "rushBuildGraphPluginTestRepo/common/autoinstallers/plugins/node_modules/@rushstack/rush-build-graph-plugin/lib"
+ ],
+ "fileExtensions": [".json", ".js", ".map"],
+ "hardlink": true
+ },
+ {
+ "sourcePath": ".",
+ "includeGlobs": ["rush-plugin-manifest.json"],
+ "destinationFolders": [
+ "rushBuildGraphPluginTestRepo/common/autoinstallers/plugins/node_modules/@rushstack/rush-build-graph-plugin/"
+ ]
+ },
+ {
+ "sourcePath": "rushBuildGraphPluginTestRepo/node_modules_mock/",
+ "destinationFolders": [
+ "rushBuildGraphPluginTestRepo/common/autoinstallers/plugins/node_modules/"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+}

rush-plugins/rush-build-graph-plugin/config/rig.json

@@ -0,0 +1,7 @@
+{
+ // The "rig.json" file directs tools to look for their config files in an external package.
+ // 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": "local-node-rig"
+}

rush-plugins/rush-build-graph-plugin/examples/graph.json

@@ -0,0 +1,31 @@
+{
+ "nodes": [
+ {
+ "id": "package-a#_phase:build",
+ "task": "_phase:build",
+ "package": "package-a",
+ "dependencies": [],
+ "workingDirectory": "a",
+ "command": "heft run build command "
+ },
+ {
+ "id": "package-b#_phase:build",
+ "task": "_phase:build",
+ "package": "package-b",
+ "dependencies": ["package-a#_phase:build"],
+ "workingDirectory": "b",
+ "command": "heft run a different build command "
+ },
+ {
+ "id": "package-b#_phase:test",
+ "task": "_phase:test",
+ "package": "package-b",
+ "dependencies": ["package-b#_phase:build"],
+ "workingDirectory": "b",
+ "command": "heft run a test command "
+ }
+ ],
+ "repoSettings": {
+ "commonTempFolder": "common/temp"
+ }
+}

rush-plugins/rush-build-graph-plugin/package.json

@@ -0,0 +1,33 @@
+{
+ "name": "@rushstack/rush-build-graph-plugin",
+ "version": "0.1.0",
+ "description": "Plugin for providing access to Rush build graph.",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/microsoft/rushstack",
+ "directory": "rush-plugins/rush-build-graph-plugin"
+ },
+ "homepage": "https://rushjs.io",
+ "main": "lib/index.js",
+ "types": "lib/index.d.ts",
+ "license": "MIT",
+ "scripts": {
+ "build": "heft build --clean",
+ "test": "heft test --clean",
+ "clean": "heft clean",
+ "start": "heft build --clean --watch",
+ "test-watch": "heft test-watch",
+ "_phase:build": "heft run --only build -- --clean",
+ "_phase:test": "heft run --only test -- --clean"
+ },
+ "devDependencies": {
+ "@rushstack/heft": "workspace:*",
+ "@rushstack/node-core-library": "workspace:*",
+ "@rushstack/rush-sdk": "workspace:*",
+ "@rushstack/terminal": "workspace:*",
+ "local-node-rig": "workspace:*",
+ "@microsoft/rush-lib": "workspace:*",
+ "eslint": "~8.57.0"
+ },
+ "sideEffects": false
+}

rush-plugins/rush-build-graph-plugin/rush-plugin-manifest.json

@@ -0,0 +1,10 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush-plugin-manifest.schema.json",
+ "plugins": [
+ {
+ "pluginName": "@rushstack/rush-build-graph-plugin",
+ "description": "Plugin for providing access to Rush build graph.",
+ "entryPoint": "lib/index.js"
+ }
+ ]
+}

rush-plugins/rush-build-graph-plugin/rushBuildGraphPluginTestRepo/a/package.json

@@ -0,0 +1,8 @@
+{
+ "name": "package-a",
+ "version": "1.0.0",
+ "description": "Test package a",
+ "scripts": {
+ "_phase:build": "heft run build command"
+ }
+}

rush-plugins/rush-build-graph-plugin/rushBuildGraphPluginTestRepo/b/package.json

@@ -0,0 +1,12 @@
+{
+ "name": "package-b",
+ "version": "1.0.0",
+ "description": "Test package b",
+ "dependencies": {
+ "package-a": "1.0.0"
+ },
+ "scripts": {
+ "_phase:build": "heft run a different build command",
+ "_phase:test": "heft run a test command"
+ }
+}

rush-plugins/rush-build-graph-plugin/rushBuildGraphPluginTestRepo/common/autoinstallers/plugins/package.json

@@ -0,0 +1,6 @@
+{
+ "name": "plugins",
+ "version": "1.0.0",
+ "private": true,
+ "dependencies": {}
+}

rush-plugins/rush-build-graph-plugin/rushBuildGraphPluginTestRepo/common/autoinstallers/plugins/rush-plugins/@rushstack/rush-build-graph-plugin/rush-plugin-manifest.json

@@ -0,0 +1,10 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush-plugin-manifest.schema.json",
+ "plugins": [
+ {
+ "pluginName": "@rushstack/rush-build-graph-plugin",
+ "description": "Plugin for providing access to Rush build graph.",
+ "entryPoint": "lib/index.js"
+ }
+ ]
+}

rush-plugins/rush-build-graph-plugin/rushBuildGraphPluginTestRepo/common/config/rush/command-line.json

@@ -0,0 +1,70 @@
+/**
+ * This configuration file defines custom commands for the "rush" command-line.
+ * More documentation is available on the Rush website: https://rushjs.io
+ */
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/command-line.schema.json",
+
+ /**
+ * Custom "commands" introduce new verbs for the command-line. To see the help for these
+ * example commands, try "rush --help", "rush my-bulk-command --help", or
+ * "rush my-global-command --help".
+ */
+ "commands": [
+ {
+ "commandKind": "phased",
+ "name": "build",
+ "summary": "run build phases",
+ "enableParallelism": false,
+ "phases": ["_phase:build"],
+ "watchOptions": {
+ "alwaysWatch": false,
+ "watchPhases": ["_phase:build"]
+ }
+ },
+ {
+ "commandKind": "phased",
+ "name": "test",
+ "summary": "run build and test phases",
+ "enableParallelism": false,
+ "phases": ["_phase:build", "_phase:test"],
+ "watchOptions": {
+ "alwaysWatch": false,
+ "watchPhases": ["_phase:build", "_phase:test"]
+ }
+ }
+ ],
+
+ "phases": [
+ {
+ "name": "_phase:build",
+ "dependencies": {
+ "upstream": ["_phase:build"]
+ },
+ // Enforcing this script exists is handled via static validation pipeline
+ "missingScriptBehavior": "silent"
+ },
+ {
+ "name": "_phase:test",
+ "dependencies": {
+ "self": ["_phase:build"]
+ },
+ // Enforcing this script exists is handled via static validation pipeline
+ "missingScriptBehavior": "silent"
+ }
+ ],
+
+ /**
+ * Custom "parameters" introduce new parameters for specified Rush command-line commands.
+ * For example, you might define a "--production" parameter for the "rush build" command.
+ */
+ "parameters": [
+ {
+ "longName": "--drop-graph",
+ "parameterKind": "string",
+ "description": "Drops the build graph to the specified file",
+ "argumentName": "FILE_PATH",
+ "associatedCommands": ["build", "test"]
+ }
+ ]
+}