@rushstack/rush-sdk - npm Package Compare versions

Comparing version 5.97.1 to 5.98.0

lib/api/CommandLineConfiguration.d.ts

@@ -7,2 +7,7 @@ import type { CommandLineParameter } from '@rushstack/ts-command-line';
 /**
+ * The set of valid behaviors for a missing script in a project's package.json scripts for a given phase.
+ * @alpha
+ */
+export declare type PhaseBehaviorForMissingScript = 'silent' | 'log' | 'error';
+/**
  * Metadata about a phase.
@@ -39,7 +44,2 @@ * @alpha
     /**
-     * Normally Rush requires that each project's package.json has a `"scripts"` entry matching the phase name.
-     * To disable this check, set `ignoreMissingScript` to true.
-     */
-    ignoreMissingScript: boolean;
-    /**
      * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is
@@ -50,2 +50,6 @@ * set to `true`, Rush will return a zero exit code if warnings occur during the execution of this phase.
     /**
+     * What should happen if the script is not defined in a project's package.json scripts field. Default is "error".
+     */
+    missingScriptBehavior: PhaseBehaviorForMissingScript;
+    /**
      * (Optional) If the `shellCommand` field is set for a bulk command, Rush will invoke it for each
@@ -52,0 +56,0 @@ * selected project; otherwise, Rush will invoke the package.json `"scripts"` entry matching Rush command/phase name.

lib/api/CommandLineJson.d.ts

@@ -92,2 +92,6 @@ /**
     /**
+     * What should happen if the script is not defined in a project's package.json scripts field. Default is "error". Supersedes \"ignoreMissingScript\".
+     */
+    missingScriptBehavior?: 'silent' | 'log' | 'error';
+    /**
      * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is set to \"true\", Rush will return a zero exit code if warnings occur during the execution of this phase.
@@ -94,0 +98,0 @@ */

lib/api/ExperimentsConfiguration.d.ts

@@ -47,2 +47,6 @@ /**
     printEventHooksOutputToConsole?: boolean;
+    /**
+     * If true, Rush will not allow node_modules in the repo folder or in parent folders.
+     */
+    forbidPhantomResolvableNodeModulesFolders?: boolean;
 }
@@ -49,0 +53,0 @@ /**

lib/api/RushConfiguration.d.ts

@@ -438,2 +438,3 @@ import { JsonNull, PackageNameParser } from '@rushstack/node-core-library';
     static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration;
+    static tryLoadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration | undefined;
     static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration;
@@ -440,0 +441,0 @@ /**

lib/cli/actions/DeployAction.d.ts

 import { BaseRushAction } from './BaseRushAction';
-import { RushCommandLineParser } from '../RushCommandLineParser';
+import type { RushCommandLineParser } from '../RushCommandLineParser';
 export declare class DeployAction extends BaseRushAction {
+    private readonly _logger;
     private readonly _scenario;
@@ -9,2 +10,3 @@ private readonly _project;
     private readonly _createArchivePath;
+    private readonly _createArchiveOnly;
     constructor(parser: RushCommandLineParser);
@@ -11,0 +13,0 @@ protected runAsync(): Promise<void>;

lib/cli/actions/PublishAction.d.ts

@@ -37,3 +37,3 @@ import { RushCommandLineParser } from '../RushCommandLineParser';
     private _validate;
-    private _publishChanges;
+    private _publishChangesAsync;
     private _publishAll;
@@ -40,0 +40,0 @@ private _gitAddTags;

lib/cli/RushPnpmCommandLineParser.d.ts

@@ -12,16 +12,15 @@ import { ITerminalProvider } from '@rushstack/node-core-library';
 export declare class RushPnpmCommandLineParser {
-    private _terminal;
-    private _rushConfiguration;
-    private _pnpmArgs;
+    private readonly _terminal;
+    private readonly _rushConfiguration;
+    private readonly _pnpmArgs;
     private _commandName;
-    private _debugEnabled;
-    private _verboseEnabled;
-    constructor(options: IRushPnpmCommandLineParserOptions);
+    private readonly _debugEnabled;
+    private constructor();
+    static initializeAsync(options: IRushPnpmCommandLineParserOptions): Promise<RushPnpmCommandLineParser>;
     executeAsync(): Promise<void>;
-    private _validatePnpmUsage;
+    private _validatePnpmUsageAsync;
     private _execute;
     private _postExecuteAsync;
     private _doRushUpdateAsync;
-    private _reportErrorAndSetExitCode;
 }
 //# sourceMappingURL=RushPnpmCommandLineParser.d.ts.map

lib/index.d.ts

@@ -14,3 +14,3 @@ /**
 export { FileSystemBuildCacheProvider, IFileSystemBuildCacheProviderOptions } from './logic/buildCache/FileSystemBuildCacheProvider';
-export { IPhase } from './api/CommandLineConfiguration';
+export { IPhase, PhaseBehaviorForMissingScript as IPhaseBehaviorForMissingScript } from './api/CommandLineConfiguration';
 export { EnvironmentConfiguration, EnvironmentVariableNames, IEnvironmentConfigurationInitializeOptions } from './api/EnvironmentConfiguration';
@@ -17,0 +17,0 @@ export { RushConstants } from './logic/RushConstants';

lib/logic/base/BaseInstallManagerTypes.d.ts

@@ -16,2 +16,6 @@ export interface IInstallManagerOptions {
     /**
+     * Whether a "--bypass-policy" flag can be specified.
+     */
+    bypassPolicyAllowed?: boolean;
+    /**
      * Whether to skip policy checks.
@@ -18,0 +22,0 @@ */

lib/logic/ChangeFiles.d.ts

@@ -22,3 +22,3 @@ import { IChangelog } from '../api/Changelog';
      */
-    getFiles(): string[];
+    getFilesAsync(): Promise<string[]>;
     /**
@@ -31,5 +31,5 @@ * Get the path of changes folder.
      */
-    deleteAll(shouldDelete: boolean, updatedChangelogs?: IChangelog[]): number;
-    private _deleteFiles;
+    deleteAllAsync(shouldDelete: boolean, updatedChangelogs?: IChangelog[]): Promise<number>;
+    private _deleteFilesAsync;
 }
 //# sourceMappingURL=ChangeFiles.d.ts.map

lib/logic/ChangeManager.d.ts

@@ -26,3 +26,3 @@ import { IPackageJson } from '@rushstack/node-core-library';
      */
-    load(changesPath: string, prereleaseToken?: PrereleaseToken, includeCommitDetails?: boolean): void;
+    loadAsync(changesPath: string, prereleaseToken?: PrereleaseToken, includeCommitDetails?: boolean): Promise<void>;
     hasChanges(): boolean;
@@ -38,4 +38,4 @@ get packageChanges(): IChangeInfo[];
     apply(shouldCommit: boolean): Map<string, IPackageJson> | undefined;
-    updateChangelog(shouldCommit: boolean): void;
+    updateChangelogAsync(shouldCommit: boolean): Promise<void>;
 }
 //# sourceMappingURL=ChangeManager.d.ts.map

lib/logic/deploy/DeployScenarioConfiguration.d.ts

@@ -1,2 +0,3 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
+import { type ITerminal } from '@rushstack/node-core-library';
+import type { RushConfiguration } from '../../api/RushConfiguration';
 export interface IDeployScenarioProjectJson {
@@ -37,4 +38,4 @@ projectName: string;
     static getConfigFilePath(scenarioName: string | undefined, rushConfiguration: RushConfiguration): string;
-    static loadFromFile(scenarioFilePath: string, rushConfiguration: RushConfiguration): DeployScenarioConfiguration;
+    static loadFromFile(terminal: ITerminal, scenarioFilePath: string, rushConfiguration: RushConfiguration): DeployScenarioConfiguration;
 }
 //# sourceMappingURL=DeployScenarioConfiguration.d.ts.map

lib/logic/policy/GitEmailPolicy.d.ts

@@ -1,6 +0,5 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
-export declare class GitEmailPolicy {
-    static validate(rushConfiguration: RushConfiguration): void;
-    static getEmailExampleLines(rushConfiguration: RushConfiguration): string[];
-}
+import type { RushConfiguration } from '../../api/RushConfiguration';
+import type { IPolicyValidatorOptions } from './PolicyValidator';
+export declare function validate(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
+export declare function getEmailExampleLines(rushConfiguration: RushConfiguration): string[];
 //# sourceMappingURL=GitEmailPolicy.d.ts.map

lib/logic/policy/PolicyValidator.d.ts

@@ -1,3 +0,4 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
+import type { RushConfiguration } from '../../api/RushConfiguration';
 export interface IPolicyValidatorOptions {
+    bypassPolicyAllowed?: boolean;
     bypassPolicy?: boolean;
@@ -7,5 +8,3 @@ allowShrinkwrapUpdates?: boolean;
 }
-export declare class PolicyValidator {
-    static validatePolicy(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
-}
+export declare function validatePolicyAsync(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): Promise<void>;
 //# sourceMappingURL=PolicyValidator.d.ts.map

lib/logic/policy/ShrinkwrapFilePolicy.d.ts

@@ -1,4 +0,4 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
-import { IPolicyValidatorOptions } from './PolicyValidator';
-import { RepoStateFile } from '../RepoStateFile';
+import type { RushConfiguration } from '../../api/RushConfiguration';
+import type { IPolicyValidatorOptions } from './PolicyValidator';
+import type { RepoStateFile } from '../RepoStateFile';
 export interface IShrinkwrapFilePolicyValidatorOptions extends IPolicyValidatorOptions {
@@ -10,5 +10,3 @@ repoState: RepoStateFile;
  */
-export declare class ShrinkwrapFilePolicy {
-    static validate(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
-}
+export declare function validate(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
 //# sourceMappingURL=ShrinkwrapFilePolicy.d.ts.map

lib/logic/PublishUtilities.d.ts

@@ -18,3 +18,3 @@ import { type IPackageJson } from '@rushstack/node-core-library';
      */
-    static findChangeRequests(allPackages: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, changeFiles: ChangeFiles, includeCommitDetails?: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): IChangeRequests;
+    static findChangeRequestsAsync(allPackages: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, changeFiles: ChangeFiles, includeCommitDetails?: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): Promise<IChangeRequests>;
     /**
@@ -21,0 +21,0 @@ * Given the changes hash, flattens them into a sorted array based on their dependency order.

lib/logic/RushConstants.d.ts

@@ -218,3 +218,7 @@ /**
     static readonly defaultWatchDebounceMs: number;
+    /**
+     * The name of the parameter that can be used to bypass policies.
+     */
+    static readonly bypassPolicyFlagLongName: '--bypass-policy';
 }
 //# sourceMappingURL=RushConstants.d.ts.map

lib/pluginFramework/RushSession.d.ts

@@ -16,3 +16,3 @@ import { ITerminalProvider } from '@rushstack/node-core-library';
  */
-export declare type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider;
+export declare type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider | Promise<ICloudBuildCacheProvider>;
 /**
@@ -19,0 +19,0 @@ * @beta

lib/utilities/PathConstants.d.ts

@@ -18,3 +18,2 @@ /**
 export declare const installRunRushPnpmScriptFilename: string;
-export declare const createLinksScriptFilename: string;
 /**
@@ -21,0 +20,0 @@ * The path to the scripts folder in rush-lib/dist.

lib/utilities/Utilities.d.ts

 /// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import * as child_process from 'child_process';
-import type * as stream from 'stream';
 import { RushConfiguration } from '../api/RushConfiguration';
@@ -88,6 +85,2 @@ import { syncNpmrc } from './npmrcUtilities';
     /**
-     * Returns the values from a Set<T>
-     */
-    static getSetAsArray<T>(set: Set<T> | ReadonlySet<T>): T[];
-    /**
      * Retries a function until a timeout is reached. The function is expected to throw if it failed and
@@ -104,6 +97,2 @@ *  should be retried.
     /**
-     * Determines if the path points to a file and that it exists.
-     */
-    static fileExists(filePath: string): boolean;
-    /**
      * Determines if a path points to a directory and that it exists.
@@ -118,6 +107,2 @@ */
     static dangerouslyDeletePath(folderPath: string): void;
-    /**
-     * Attempts to delete a file. If it does not exist, or the path is not a file, it no-ops.
-     */
-    static deleteFile(filePath: string): void;
     static isFileTimestampCurrent(dateToCompare: Date, inputFilenames: string[]): boolean;
@@ -168,3 +153,2 @@ /**
     static usingAsync<TDisposable extends IDisposable>(getDisposableAsync: () => Promise<TDisposable> | IDisposable, doActionAsync: (disposable: TDisposable) => Promise<void> | void): Promise<void>;
-    static readStreamToBufferAsync(stream: stream.Readable): Promise<Buffer>;
     private static _executeLifecycleCommandInternal;
@@ -171,0 +155,0 @@ /**

package.json

 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.97.1",
+  "version": "5.98.0",
   "description": "An API for interacting with the Rush engine",
@@ -17,3 +17,3 @@ "repository": {
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "3.55.2"
+    "@rushstack/node-core-library": "3.59.0"
   },
@@ -24,9 +24,9 @@ "devDependencies": {
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.97.1",
+    "@microsoft/rush-lib": "5.98.0",
     "@rushstack/eslint-config": "3.2.0",
-    "@rushstack/heft": "0.50.0",
-    "@rushstack/heft-node-rig": "1.12.6",
-    "@rushstack/stream-collator": "4.0.229",
+    "@rushstack/heft": "0.50.5",
+    "@rushstack/heft-node-rig": "1.12.11",
+    "@rushstack/stream-collator": "4.0.234",
     "@rushstack/ts-command-line": "4.13.2",
-    "@rushstack/terminal": "0.5.4"
+    "@rushstack/terminal": "0.5.9"
   },
@@ -33,0 +33,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

532169

increased by0.36%

Number of package files

360

increased by0.56%

Lines of code

12005

increased by0.18%

Dependency changes

• + Added@rushstack/node-core-library@3.59.0(transitive)

• - Removed@rushstack/node-core-library@3.55.2(transitive)

• Updated@rushstack/node-core-library@3.59.0