@rushstack/rush-sdk 5.149.1 → 5.151.0

package/dist/rush-lib.d.ts

@@ -1239,6 +1239,13 @@ export declare interface ICreateOperationsContext {
      * The Rush configuration
      */
     readonly rushConfiguration: RushConfiguration;
+    /**
+     * If true, Rush will automatically include the dependent phases for the specified set of phases.
+     * @remarks
+     * If the selection of projects was "unsafe" (i.e. missing some dependencies), this will add the
+     * minimum number of phases required to make it safe.
+     */
+    readonly includePhaseDeps: boolean;
     /**
      * Marks an operation's result as invalid, potentially triggering a new build. Only applicable in watch mode.
      * @param operation - The operation to invalidate
@@ -1799,8 +1806,6 @@ export declare interface _IOperationMetadata {
  * @internal
  */
 export declare interface _IOperationMetadataManagerOptions {
-    rushProject: RushConfigurationProject;
-    phase: IPhase;
     operation: Operation;
 }
 
@@ -1810,13 +1815,13 @@ export declare interface _IOperationMetadataManagerOptions {
  */
 export declare interface IOperationOptions {
     /**
-     * The Rush phase associated with this Operation, if any
+     * The Rush phase associated with this Operation
      */
-    phase?: IPhase | undefined;
+    phase: IPhase;
     /**
-     * The Rush project associated with this Operation, if any
+     * The Rush project associated with this Operation
      */
-    project?: RushConfigurationProject | undefined;
+    project: RushConfigurationProject;
     /**
      * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
      * running the operation.
@@ -1899,7 +1904,7 @@ export declare interface IOperationRunnerContext {
      *
      * @internal
      */
-    _operationMetadataManager?: _OperationMetadataManager;
+    _operationMetadataManager: _OperationMetadataManager;
     /**
      * Object used to track elapsed time.
      */
@@ -2764,13 +2769,13 @@ export declare class NpmOptionsConfiguration extends PackageManagerOptionsConfig
  */
 export declare class Operation {
     /**
-     * The Rush phase associated with this Operation, if any
+     * The Rush phase associated with this Operation
      */
-    readonly associatedPhase: IPhase | undefined;
+    readonly associatedPhase: IPhase;
     /**
-     * The Rush project associated with this Operation, if any
+     * The Rush project associated with this Operation
      */
-    readonly associatedProject: RushConfigurationProject | undefined;
+    readonly associatedProject: RushConfigurationProject;
     /**
      * A set of all operations which depend on this operation.
      */
@@ -2817,7 +2822,7 @@ export declare class Operation {
     /**
      * The name of this operation, for logging.
      */
-    get name(): string | undefined;
+    get name(): string;
     /**
      * If set to true, this operation is considered a no-op and can be considered always skipped for analysis purposes.
      */

package/dist/tsdoc-metadata.json

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

package/lib/api/CommandLineConfiguration.d.ts

@@ -140,6 +140,7 @@ export declare class CommandLineConfiguration {
      * @param cycleFreePhases Phases that have already been fully walked and confirmed to not be in any cycles
      */
     private _checkForPhaseSelfCycles;
+    private static _applyBuildCommandDefaults;
     /**
      * Load the command-line.json configuration file from the specified path. Note that this
      * does not include the default build settings. This option is intended to be used to load
@@ -154,7 +155,7 @@ export declare class CommandLineConfiguration {
      * settings.  If the file does not exist, then a default instance is returned.
      * If the file contains errors, then an exception is thrown.
      */
-    static loadFromFileOrDefault(jsonFilePath?: string): CommandLineConfiguration;
+    static loadFromFileOrDefault(jsonFilePath?: string, doNotIncludeDefaultBuildCommands?: boolean): CommandLineConfiguration;
     prependAdditionalPathFolder(pathFolder: string): void;
     private _translateBulkCommandToPhasedCommand;
 }

package/lib/cli/RushCommandLineParser.d.ts

@@ -26,6 +26,7 @@ export declare class RushCommandLineParser extends CommandLineParser {
     private readonly _rushOptions;
     private readonly _terminalProvider;
     private readonly _terminal;
+    private readonly _autocreateBuildCommand;
     constructor(options?: Partial<IRushCommandLineParserOptions>);
     get isDebug(): boolean;
     get isQuiet(): boolean;

package/lib/cli/scriptActions/PhasedScriptAction.d.ts

@@ -54,6 +54,7 @@ export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandC
     private readonly _variantParameter;
     private readonly _noIPCParameter;
     private readonly _nodeDiagnosticDirParameter;
+    private readonly _includePhaseDeps;
     constructor(options: IPhasedScriptActionOptions);
     runAsync(): Promise<void>;
     private _runInitialPhasesAsync;

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" preserve="true" />
 /**
  * A library for writing scripts that interact with the {@link https://rushjs.io/ | Rush} tool.
  * @packageDocumentation

package/lib/logic/InteractiveUpgrader.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../../src/npm-check-typings.d.ts" preserve="true" />
 import type { RushConfiguration } from '../api/RushConfiguration';
 import { type IDepsToUpgradeAnswers } from '../utilities/InteractiveUpgradeUI';
 import type { RushConfigurationProject } from '../api/RushConfigurationProject';

package/lib/logic/PackageJsonUpdater.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="../../src/npm-check-typings.d.ts" />
+/// <reference path="../../src/npm-check-typings.d.ts" preserve="true" />
 import type * as NpmCheck from 'npm-check';
 import type { RushConfiguration } from '../api/RushConfiguration';
 import { DependencyType } from '../api/PackageJsonEditor';

package/lib/logic/buildCache/FileSystemBuildCacheProvider.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ITerminal } from '@rushstack/terminal';
 import type { RushConfiguration } from '../../api/RushConfiguration';
 import type { RushUserConfiguration } from '../../api/RushUserConfiguration';

package/lib/logic/buildCache/ICloudBuildCacheProvider.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ITerminal } from '@rushstack/terminal';
 /**
  * @beta

package/lib/logic/installManager/InstallHelpers.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { type ITerminal } from '@rushstack/terminal';
 import type { RushConfiguration } from '../../api/RushConfiguration';
 import type { RushGlobalFolder } from '../../api/RushGlobalFolder';

package/lib/logic/operations/IOperationRunner.d.ts

@@ -27,7 +27,7 @@ export interface IOperationRunnerContext {
      *
      * @internal
      */
-    _operationMetadataManager?: OperationMetadataManager;
+    _operationMetadataManager: OperationMetadataManager;
     /**
      * Object used to track elapsed time.
      */

package/lib/logic/operations/Operation.d.ts

@@ -8,13 +8,13 @@ import type { IOperationSettings } from '../../api/RushProjectConfiguration';
  */
 export interface IOperationOptions {
     /**
-     * The Rush phase associated with this Operation, if any
+     * The Rush phase associated with this Operation
      */
-    phase?: IPhase | undefined;
+    phase: IPhase;
     /**
-     * The Rush project associated with this Operation, if any
+     * The Rush project associated with this Operation
      */
-    project?: RushConfigurationProject | undefined;
+    project: RushConfigurationProject;
     /**
      * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
      * running the operation.
@@ -40,13 +40,13 @@ export interface IOperationOptions {
  */
 export declare class Operation {
     /**
-     * The Rush phase associated with this Operation, if any
+     * The Rush phase associated with this Operation
      */
-    readonly associatedPhase: IPhase | undefined;
+    readonly associatedPhase: IPhase;
     /**
-     * The Rush project associated with this Operation, if any
+     * The Rush project associated with this Operation
      */
-    readonly associatedProject: RushConfigurationProject | undefined;
+    readonly associatedProject: RushConfigurationProject;
     /**
      * A set of all operations which depend on this operation.
      */
@@ -93,7 +93,7 @@ export declare class Operation {
     /**
      * The name of this operation, for logging.
      */
-    get name(): string | undefined;
+    get name(): string;
     /**
      * If set to true, this operation is considered a no-op and can be considered always skipped for analysis purposes.
      */

package/lib/logic/operations/OperationExecutionRecord.d.ts

@@ -77,9 +77,9 @@ export declare class OperationExecutionRecord implements IOperationRunnerContext
     readonly stopwatch: Stopwatch;
     readonly stdioSummarizer: StdioSummarizer;
     readonly runner: IOperationRunner;
-    readonly associatedPhase: IPhase | undefined;
-    readonly associatedProject: RushConfigurationProject | undefined;
-    readonly _operationMetadataManager: OperationMetadataManager | undefined;
+    readonly associatedPhase: IPhase;
+    readonly associatedProject: RushConfigurationProject;
+    readonly _operationMetadataManager: OperationMetadataManager;
     logFilePaths: ILogFilePaths | undefined;
     private readonly _context;
     private _collatedWriter;

package/lib/logic/operations/OperationMetadataManager.d.ts

@@ -1,14 +1,10 @@
 import { type ITerminalChunk, type ITerminal, type ITerminalProvider } from '@rushstack/terminal';
 import { OperationStateFile } from './OperationStateFile';
-import type { IPhase } from '../../api/CommandLineConfiguration';
-import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import type { Operation } from './Operation';
 /**
  * @internal
  */
 export interface IOperationMetadataManagerOptions {
-    rushProject: RushConfigurationProject;
-    phase: IPhase;
     operation: Operation;
 }
 /**

package/lib/logic/operations/ShellOperationRunner.d.ts

@@ -10,7 +10,7 @@ export interface IShellOperationRunnerOptions {
     commandForHash: string;
 }
 /**
- * An `IOperationRunner` subclass that performs an operation via a shell command.
+ * An `IOperationRunner` implementation that performs an operation via a shell command.
  * Currently contains the build cache logic, pending extraction as separate operations.
  * Supports skipping an operation if allowed and it is already up-to-date.
  */
@@ -21,6 +21,10 @@ export declare class ShellOperationRunner implements IOperationRunner {
     readonly cacheable: boolean;
     readonly warningsAreAllowed: boolean;
     readonly commandToRun: string;
+    /**
+     * The creator is expected to use a different runner if the command is known to be a noop.
+     */
+    readonly isNoOp: boolean;
     private readonly _commandForHash;
     private readonly _rushProject;
     constructor(options: IShellOperationRunnerOptions);

package/lib/logic/setup/KeyboardLoop.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import * as readline from 'readline';
 export declare class KeyboardLoop {
     protected stdin: NodeJS.ReadStream;

package/lib/pluginFramework/PhasedCommandHooks.d.ts

@@ -80,6 +80,13 @@ export interface ICreateOperationsContext {
      * The Rush configuration
      */
     readonly rushConfiguration: RushConfiguration;
+    /**
+     * If true, Rush will automatically include the dependent phases for the specified set of phases.
+     * @remarks
+     * If the selection of projects was "unsafe" (i.e. missing some dependencies), this will add the
+     * minimum number of phases required to make it safe.
+     */
+    readonly includePhaseDeps: boolean;
     /**
      * Marks an operation's result as invalid, potentially triggering a new build. Only applicable in watch mode.
      * @param operation - The operation to invalidate

package/lib/utilities/InteractiveUpgradeUI.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="../../src/npm-check-typings.d.ts" />
+/// <reference path="../../src/npm-check-typings.d.ts" preserve="true" />
 import type * as NpmCheck from 'npm-check';
 export interface IUIGroup {
     title: string;

package/lib/utilities/Utilities.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import * as child_process from 'child_process';
 import { type IWaitForExitResult } from '@rushstack/node-core-library';
 import type { RushConfiguration } from '../api/RushConfiguration';

package/lib/utilities/WebClient.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { type RequestOptions } from 'node:https';
 /**
  * For use with {@link WebClient}.

package/lib/utilities/npmrcUtilities.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface ILogger {
     info: (string: string) => void;
     error: (string: string) => void;

package/lib-shim/index.js

@@ -269,9 +269,12 @@ function syncNpmrc(options) {
             if (!external_fs_.existsSync(targetNpmrcFolder)) {
                 external_fs_.mkdirSync(targetNpmrcFolder, { recursive: true });
             }
-            return _copyAndTrimNpmrcFile(Object.assign({ sourceNpmrcPath,
+            return _copyAndTrimNpmrcFile({
+                sourceNpmrcPath,
                 targetNpmrcPath,
-                logger }, options));
+                logger,
+                ...options
+            });
         }
         else if (external_fs_.existsSync(targetNpmrcPath)) {
             // If the source .npmrc doesn't exist and there is one in the target, delete the one in the target
@@ -1493,7 +1496,12 @@ class Utilities {
         const environment = Utilities._createEnvironmentForRushCommand({
             initCwd: options.initCwd,
             initialEnvironment: options.initialEnvironment,
-            pathOptions: Object.assign(Object.assign({}, options.environmentPathOptions), { rushJsonFolder: (_a = options.rushConfiguration) === null || _a === void 0 ? void 0 : _a.rushJsonFolder, projectRoot: options.workingDirectory, commonTempFolder: options.rushConfiguration ? options.rushConfiguration.commonTempFolder : undefined })
+            pathOptions: {
+                ...options.environmentPathOptions,
+                rushJsonFolder: (_a = options.rushConfiguration) === null || _a === void 0 ? void 0 : _a.rushJsonFolder,
+                projectRoot: options.workingDirectory,
+                commonTempFolder: options.rushConfiguration ? options.rushConfiguration.commonTempFolder : undefined
+            }
         });
         const stdio = options.handleOutput ? ['pipe', 'pipe', 'pipe'] : [0, 1, 2];
         if (options.ipc) {
@@ -1707,15 +1715,28 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.requireRushLibUnderFolderPath = exports._require = exports.tryFindRushJsonLocation = exports.sdkContext = exports.RUSH_LIB_PATH_ENV_VAR_NAME = exports.RUSH_LIB_NAME = void 0;
+exports.sdkContext = exports.RUSH_LIB_PATH_ENV_VAR_NAME = exports.RUSH_LIB_NAME = void 0;
+exports.tryFindRushJsonLocation = tryFindRushJsonLocation;
+exports._require = _require;
+exports.requireRushLibUnderFolderPath = requireRushLibUnderFolderPath;
 const path = __importStar(__webpack_require__(/*! path */ "path"));
 const node_core_library_1 = __webpack_require__(/*! @rushstack/node-core-library */ "@rushstack/node-core-library");
 exports.RUSH_LIB_NAME = '@microsoft/rush-lib';
@@ -1745,7 +1766,6 @@ function tryFindRushJsonLocation(startingFolder) {
     }
     return undefined;
 }
-exports.tryFindRushJsonLocation = tryFindRushJsonLocation;
 function _require(moduleName) {
     if (typeof require === 'function') {
         // If this library has been bundled with Webpack, we need to call the real `require` function
@@ -1758,7 +1778,6 @@ function _require(moduleName) {
         return require(moduleName);
     }
 }
-exports._require = _require;
 /**
  * Require `@microsoft/rush-lib` under the specified folder path.
  */
@@ -1769,7 +1788,6 @@ function requireRushLibUnderFolderPath(folderPath) {
     });
     return _require(rushLibModulePath);
 }
-exports.requireRushLibUnderFolderPath = requireRushLibUnderFolderPath;
 //# sourceMappingURL=helpers.js.map
 
 /***/ }),
@@ -1800,16 +1818,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var _a;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports._rushSdk_loadInternalModule = void 0;
+exports._rushSdk_loadInternalModule = _rushSdk_loadInternalModule;
 const path = __importStar(__webpack_require__(/*! path */ "path"));
 const node_core_library_1 = __webpack_require__(/*! @rushstack/node-core-library */ "@rushstack/node-core-library");
 const terminal_1 = __webpack_require__(/*! @rushstack/terminal */ "@rushstack/terminal");
@@ -1986,7 +2014,6 @@ function _rushSdk_loadInternalModule(srcImportPath) {
     }
     return exports._RushInternals.loadModule(srcImportPath);
 }
-exports._rushSdk_loadInternalModule = _rushSdk_loadInternalModule;
 //# sourceMappingURL=index.js.map
 
 /***/ }),