@rushstack/rush-sdk 5.117.0 → 5.117.1

package/dist/rush-lib.d.ts

@@ -11,6 +11,7 @@ import { AsyncSeriesHook } from 'tapable';
 import { AsyncSeriesWaterfallHook } from 'tapable';
 import type { CollatedWriter } from '@rushstack/stream-collator';
 import type { CommandLineParameter } from '@rushstack/ts-command-line';
+import { CommandLineParameterKind } from '@rushstack/ts-command-line';
 import { HookMap } from 'tapable';
 import { IPackageJson } from '@rushstack/node-core-library';
 import { ITerminal } from '@rushstack/terminal';
@@ -916,6 +917,20 @@ declare interface IApprovedPackagesPolicyJson {
 declare interface IBaseBuildCacheJson {
     buildCacheEnabled: boolean;
     cacheProvider: string;
+    /**
+     * Used to specify the cache entry ID format. If this property is set, it must
+     * contain a `[hash]` token. It may also contain one of the following tokens:
+     * - `[projectName]`
+     * - `[projectName:normalize]`
+     * - `[phaseName]`
+     * - `[phaseName:normalize]`
+     * - `[phaseName:trimPrefix]`
+     * - `[os]`
+     * - `[arch]`
+     * @privateRemarks
+     * NOTE: If you update this comment, make sure to update build-cache.json in the "rush init" template.
+     * The token parser is in CachEntryId.ts
+     */
     cacheEntryNamePattern?: string;
 }
 
@@ -1971,6 +1986,57 @@ export declare interface IRushCommand {
     readonly actionName: string;
 }
 
+/**
+ * The full spec of an available Rush command line action
+ *
+ * @beta
+ */
+export declare interface IRushCommandLineAction {
+    actionName: string;
+    parameters: IRushCommandLineParameter[];
+}
+
+/**
+ * Information about the available parameters associated with a Rush action
+ *
+ * @beta
+ */
+export declare interface IRushCommandLineParameter {
+    /**
+     * The corresponding string representation of CliParameterKind
+     */
+    readonly kind: keyof typeof CommandLineParameterKind;
+    /**
+     * The long name of the flag including double dashes, e.g. "--do-something"
+     */
+    readonly longName: string;
+    /**
+     * An optional short name for the flag including the dash, e.g. "-d"
+     */
+    readonly shortName?: string;
+    /**
+     * Documentation for the parameter that will be shown when invoking the tool with "--help"
+     */
+    readonly description: string;
+    /**
+     * If true, then an error occurs if the parameter was not included on the command-line.
+     */
+    readonly required?: boolean;
+    /**
+     * If provided, this parameter can also be provided by an environment variable with the specified name.
+     */
+    readonly environmentVariable?: string;
+}
+
+/**
+ * The full spec of a Rush CLI
+ *
+ * @beta
+ */
+export declare interface IRushCommandLineSpec {
+    actions: IRushCommandLineAction[];
+}
+
 /**
  * This represents the JSON data structure for the "rush.json" configuration file.
  * See rush.schema.json for documentation.
@@ -3305,6 +3371,15 @@ export declare class Rush {
     private static _normalizeLaunchOptions;
 }
 
+/**
+ * Information about the available CLI commands
+ *
+ * @beta
+ */
+export declare class RushCommandLine {
+    static getCliSpec(rushJsonFolder: string): IRushCommandLineSpec;
+}
+
 /**
  * This represents the Rush configuration for a repository, based on the "rush.json"
  * configuration file.

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.41.0"
+      "packageVersion": "7.42.0"
     }
   ]
 }

package/lib/api/BuildCacheConfiguration.d.ts

@@ -11,6 +11,20 @@ import type { RushSession } from '../pluginFramework/RushSession';
 export interface IBaseBuildCacheJson {
     buildCacheEnabled: boolean;
     cacheProvider: string;
+    /**
+     * Used to specify the cache entry ID format. If this property is set, it must
+     * contain a `[hash]` token. It may also contain one of the following tokens:
+     * - `[projectName]`
+     * - `[projectName:normalize]`
+     * - `[phaseName]`
+     * - `[phaseName:normalize]`
+     * - `[phaseName:trimPrefix]`
+     * - `[os]`
+     * - `[arch]`
+     * @privateRemarks
+     * NOTE: If you update this comment, make sure to update build-cache.json in the "rush init" template.
+     * The token parser is in CachEntryId.ts
+     */
     cacheEntryNamePattern?: string;
 }
 /**

package/lib/api/RushCommandLine.d.ts

@@ -0,0 +1,58 @@
+import { CommandLineParameterKind } from '@rushstack/ts-command-line';
+/**
+ * Information about the available parameters associated with a Rush action
+ *
+ * @beta
+ */
+export interface IRushCommandLineParameter {
+    /**
+     * The corresponding string representation of CliParameterKind
+     */
+    readonly kind: keyof typeof CommandLineParameterKind;
+    /**
+     * The long name of the flag including double dashes, e.g. "--do-something"
+     */
+    readonly longName: string;
+    /**
+     * An optional short name for the flag including the dash, e.g. "-d"
+     */
+    readonly shortName?: string;
+    /**
+     * Documentation for the parameter that will be shown when invoking the tool with "--help"
+     */
+    readonly description: string;
+    /**
+     * If true, then an error occurs if the parameter was not included on the command-line.
+     */
+    readonly required?: boolean;
+    /**
+     * If provided, this parameter can also be provided by an environment variable with the specified name.
+     */
+    readonly environmentVariable?: string;
+}
+/**
+ * The full spec of an available Rush command line action
+ *
+ * @beta
+ */
+export interface IRushCommandLineAction {
+    actionName: string;
+    parameters: IRushCommandLineParameter[];
+}
+/**
+ * The full spec of a Rush CLI
+ *
+ * @beta
+ */
+export interface IRushCommandLineSpec {
+    actions: IRushCommandLineAction[];
+}
+/**
+ * Information about the available CLI commands
+ *
+ * @beta
+ */
+export declare class RushCommandLine {
+    static getCliSpec(rushJsonFolder: string): IRushCommandLineSpec;
+}
+//# sourceMappingURL=RushCommandLine.d.ts.map

package/lib/api/RushCommandLine.js

@@ -0,0 +1 @@
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/RushCommandLine");

package/lib/index.d.ts

@@ -55,4 +55,5 @@ export type { ITelemetryData, ITelemetryMachineInfo, ITelemetryOperationResult }
 export { IStopwatchResult } from './utilities/Stopwatch';
 export { OperationStateFile as _OperationStateFile, IOperationStateFileOptions as _IOperationStateFileOptions, IOperationStateJson as _IOperationStateJson } from './logic/operations/OperationStateFile';
 export { OperationMetadataManager as _OperationMetadataManager, IOperationMetadataManagerOptions as _IOperationMetadataManagerOptions, IOperationMetaData as _IOperationMetadata } from './logic/operations/OperationMetadataManager';
+export { RushCommandLine, type IRushCommandLineSpec, type IRushCommandLineParameter, type IRushCommandLineAction } from './api/RushCommandLine';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.117.0",
+  "version": "5.117.1",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -25,17 +25,17 @@
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "4.0.2",
-    "@rushstack/terminal": "0.10.0"
+    "@rushstack/terminal": "0.10.0",
+    "@rushstack/node-core-library": "4.0.2"
   },
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@rushstack/heft": "0.65.5",
+    "@microsoft/rush-lib": "5.117.1",
+    "@rushstack/heft": "0.65.7",
     "local-node-rig": "1.0.0",
-    "@microsoft/rush-lib": "5.117.0",
-    "@rushstack/stream-collator": "4.1.32",
-    "@rushstack/ts-command-line": "4.17.4"
+    "@rushstack/stream-collator": "4.1.34",
+    "@rushstack/ts-command-line": "4.18.0"
   },
   "scripts": {
     "build": "heft build --clean",