@rushstack/rush-sdk 5.171.0 → 5.172.1

package/dist/rush-lib.d.ts

@@ -1611,6 +1611,16 @@ export declare interface IGetChangedProjectsOptions {
  * @beta
  */
 export declare interface IGlobalCommand extends IRushCommand {
+    /**
+     * Get a parameter by its long name (e.g. "--output-path") that was defined in command-line.json for this command.
+     * If the parameter was not defined or not provided on the command line, this will throw.
+     */
+    getCustomParametersByLongName<TParameter extends CommandLineParameter>(longName: string): TParameter;
+    /**
+     * Call this from a plugin hook to indicate that the command has been fully handled
+     * by the plugin. When set, the default shell command execution will be skipped.
+     */
+    setHandled(): void;
 }
 
 /**
@@ -4766,6 +4776,11 @@ export declare class RushConstants {
      * The value of the "commandKind" property for a global command in command-line.json
      */
     static readonly globalCommandKind: 'global';
+    /**
+     * The value of the "commandKind" property for a plugin-only global command in command-line.json.
+     * This command kind can only be used in command-line.json files provided by Rush plugins.
+     */
+    static readonly globalPluginCommandKind: 'globalPlugin';
     /**
      * The value of the "commandKind" property for a phased command in command-line.json
      */
@@ -4915,7 +4930,7 @@ export declare class RushLifecycleHooks {
      * The hook to run between preparing the common/temp folder and invoking the package manager during "rush install" or "rush update".
      */
     readonly beforeInstall: AsyncSeriesHook<[
-    command: IGlobalCommand,
+    command: IRushCommand,
     subspace: Subspace,
     variant: string | undefined
     ]>;

package/lib-dts/api/CommandLineConfiguration.d.ts

@@ -93,6 +93,12 @@ export interface IPhasedCommandConfig extends IPhasedCommandWithoutPhasesJson, I
     alwaysInstall: boolean | undefined;
 }
 export interface IGlobalCommandConfig extends IGlobalCommandJson, ICommandWithParameters {
+    /**
+     * If true, this command was declared with commandKind "globalPlugin" and its implementation
+     * is provided by a Rush plugin via the `runGlobalCustomCommand` hook. There is no shell
+     * command to execute.
+     */
+    providedByPlugin: boolean;
 }
 export type Command = IGlobalCommandConfig | IPhasedCommandConfig;
 /**

package/lib-dts/api/CommandLineJson.d.ts

@@ -2,7 +2,7 @@
  * "baseCommand" from command-line.schema.json
  */
 export interface IBaseCommandJson {
-    commandKind: 'bulk' | 'global' | 'phased';
+    commandKind: 'bulk' | 'global' | 'globalPlugin' | 'phased';
     name: string;
     summary: string;
     /**
@@ -58,7 +58,15 @@ export interface IGlobalCommandJson extends IBaseCommandJson {
     commandKind: 'global';
     shellCommand: string;
 }
-export type CommandJson = IBulkCommandJson | IGlobalCommandJson | IPhasedCommandJson;
+/**
+ * "globalPluginCommand" from command-line.schema.json.
+ * A global command whose implementation is provided entirely by a Rush plugin.
+ * This command kind can only be used in command-line.json files provided by Rush plugins.
+ */
+export interface IGlobalPluginCommandJson extends IBaseCommandJson {
+    commandKind: 'globalPlugin';
+}
+export type CommandJson = IBulkCommandJson | IGlobalCommandJson | IGlobalPluginCommandJson | IPhasedCommandJson;
 /**
  * The dependencies of a phase.
  * @alpha

package/lib-dts/cli/scriptActions/GlobalScriptAction.d.ts

@@ -1,3 +1,4 @@
+import type { CommandLineParameter } from '@rushstack/ts-command-line';
 import { BaseScriptAction, type IBaseScriptActionOptions } from './BaseScriptAction';
 import type { IGlobalCommandConfig } from '../../api/CommandLineConfiguration';
 /**
@@ -6,6 +7,7 @@ import type { IGlobalCommandConfig } from '../../api/CommandLineConfiguration';
 export interface IGlobalScriptActionOptions extends IBaseScriptActionOptions<IGlobalCommandConfig> {
     shellCommand: string;
     autoinstallerName: string | undefined;
+    providedByPlugin: boolean;
 }
 /**
  * This class implements custom commands that are run once globally for the entire repo
@@ -21,7 +23,18 @@ export declare class GlobalScriptAction extends BaseScriptAction<IGlobalCommandC
     private readonly _shellCommand;
     private readonly _autoinstallerName;
     private readonly _autoinstallerFullPath;
+    private readonly _providedByPlugin;
+    private _customParametersByLongName;
+    private _isHandled;
     constructor(options: IGlobalScriptActionOptions);
+    /**
+     * {@inheritDoc IGlobalCommand.setHandled}
+     */
+    setHandled(): void;
+    /**
+     * {@inheritDoc IGlobalCommand.getCustomParametersByLongName}
+     */
+    getCustomParametersByLongName<TParameter extends CommandLineParameter>(longName: string): TParameter;
     private _prepareAutoinstallerNameAsync;
     runAsync(): Promise<void>;
     private _expandShellCommandWithTokens;

package/lib-dts/logic/RushConstants.d.ts

@@ -217,6 +217,11 @@ export declare class RushConstants {
      * The value of the "commandKind" property for a global command in command-line.json
      */
     static readonly globalCommandKind: 'global';
+    /**
+     * The value of the "commandKind" property for a plugin-only global command in command-line.json.
+     * This command kind can only be used in command-line.json files provided by Rush plugins.
+     */
+    static readonly globalPluginCommandKind: 'globalPlugin';
     /**
      * The value of the "commandKind" property for a phased command in command-line.json
      */

package/lib-dts/pluginFramework/RushLifeCycle.d.ts

@@ -1,4 +1,5 @@
 import { AsyncParallelHook, AsyncSeriesHook, HookMap } from 'tapable';
+import type { CommandLineParameter } from '@rushstack/ts-command-line';
 import type { ITelemetryData } from '../logic/Telemetry';
 import type { PhasedCommandHooks } from './PhasedCommandHooks';
 import type { Subspace } from '../api/Subspace';
@@ -17,6 +18,16 @@ export interface IRushCommand {
  * @beta
  */
 export interface IGlobalCommand extends IRushCommand {
+    /**
+     * Get a parameter by its long name (e.g. "--output-path") that was defined in command-line.json for this command.
+     * If the parameter was not defined or not provided on the command line, this will throw.
+     */
+    getCustomParametersByLongName<TParameter extends CommandLineParameter>(longName: string): TParameter;
+    /**
+     * Call this from a plugin hook to indicate that the command has been fully handled
+     * by the plugin. When set, the default shell command execution will be skipped.
+     */
+    setHandled(): void;
 }
 /**
  * Information about the currently executing phased script command (as defined in command-line.json, or default "build" or "rebuild") provided to plugins.
@@ -65,7 +76,7 @@ export declare class RushLifecycleHooks {
      * The hook to run between preparing the common/temp folder and invoking the package manager during "rush install" or "rush update".
      */
     readonly beforeInstall: AsyncSeriesHook<[
-        command: IGlobalCommand,
+        command: IRushCommand,
         subspace: Subspace,
         variant: string | undefined
     ]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.171.0",
+  "version": "5.172.1",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -41,20 +41,20 @@
     "tapable": "2.2.1",
     "@rushstack/credential-cache": "0.2.7",
     "@rushstack/lookup-by-path": "0.9.7",
+    "@rushstack/node-core-library": "5.20.3",
     "@rushstack/terminal": "0.22.3",
-    "@rushstack/package-deps-hash": "4.7.7",
-    "@rushstack/node-core-library": "5.20.3"
+    "@rushstack/package-deps-hash": "4.7.7"
   },
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.8",
     "eslint": "~9.37.0",
     "webpack": "~5.105.2",
-    "@microsoft/rush-lib": "5.171.0",
+    "@microsoft/rush-lib": "5.172.1",
     "@rushstack/heft": "1.2.7",
+    "@rushstack/stream-collator": "4.2.7",
     "@rushstack/heft-webpack5-plugin": "1.3.7",
     "@rushstack/ts-command-line": "5.3.3",
-    "@rushstack/stream-collator": "4.2.7",
     "@rushstack/webpack-preserve-dynamic-require-plugin": "0.12.8",
     "local-node-rig": "1.0.0"
   },