@rushstack/rush-sdk - npm Package Compare versions

Comparing version 5.122.1 to 5.123.0

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.43.1"
+      "packageVersion": "7.43.2"
     }
   ]
 }

lib/api/LastInstallFlag.d.ts

@@ -1,2 +0,3 @@
-import { type JsonObject } from '@rushstack/node-core-library';
+import { type JsonObject, type IPackageJson } from '@rushstack/node-core-library';
+import type { PackageManagerName } from './packageManager/PackageManager';
 import type { RushConfiguration } from './RushConfiguration';
@@ -6,6 +7,49 @@ import type { Subspace } from './Subspace';
 /**
- * @internal
+ * This represents the JSON data structure for the "last-install.flag" file.
  */
-export interface ILockfileValidityCheckOptions {
-    statePropertiesToIgnore?: string[];
+export interface ILastInstallFlagJson {
+    /**
+     * Current node version
+     */
+    node?: string;
+    /**
+     * Current package manager name
+     */
+    packageManager?: PackageManagerName;
+    /**
+     * Current package manager version
+     */
+    packageManagerVersion: string;
+    /**
+     * Current rush json folder
+     */
+    rushJsonFolder: string;
+    /**
+     * The content of package.json, used in the flag file of autoinstaller
+     */
+    packageJson?: IPackageJson;
+    /**
+     * Same with pnpmOptions.pnpmStorePath in rush.json
+     */
+    storePath?: string;
+    /**
+     * An experimental flag used by cleanInstallAfterNpmrcChanges
+     */
+    npmrcHash?: string;
+    /**
+     * True when "useWorkspaces" is true in rush.json
+     */
+    workspaces?: boolean;
+    /**
+     * True when user explicitly specify "--ignore-scripts" CLI parameter or deferredInstallationScripts
+     */
+    ignoreScripts?: boolean;
+    /**
+     * When specified, it is a list of selected projects during partial install
+     * It is undefined when full install
+     */
+    selectedProjectNames?: string[];
+}
+interface ILockfileValidityCheckOptions {
+    statePropertiesToIgnore?: (keyof ILastInstallFlagJson)[];
     rushVerb?: string;
@@ -18,3 +62,2 @@ }
  * it can invalidate the last install.
- * @internal
  */
@@ -32,7 +75,7 @@ export declare class LastInstallFlag {
      */
-    constructor(folderPath: string, state?: JsonObject);
+    constructor(folderPath: string, state?: Partial<ILastInstallFlagJson>);
     /**
      * Returns true if the file exists and the contents match the current state.
      */
-    isValid(options?: ILockfileValidityCheckOptions): boolean;
+    isValidAsync(options?: ILockfileValidityCheckOptions): Promise<boolean>;
     /**
@@ -44,14 +87,18 @@ * Same as isValid(), but with an additional check:  If the current state is not equal to the previous
      */
-    checkValidAndReportStoreIssues(options: ILockfileValidityCheckOptions & {
+    checkValidAndReportStoreIssuesAsync(options: ILockfileValidityCheckOptions & {
         rushVerb: string;
-    }): boolean;
-    private _isValid;
+    }): Promise<boolean>;
+    private _isValidAsync;
     /**
      * Writes the flag file to disk with the current state
      */
-    create(): void;
+    createAsync(): Promise<void>;
     /**
+     * Merge new data into current state by "merge"
+     */
+    mergeFromObject(data: JsonObject): void;
+    /**
      * Removes the flag file
      */
-    clear(): void;
+    clearAsync(): Promise<void>;
     /**
@@ -78,2 +125,3 @@ * Returns the name of the flag file
 }
+export {};
 //# sourceMappingURL=LastInstallFlag.d.ts.map

lib/api/RushProjectConfiguration.d.ts

@@ -76,2 +76,7 @@ import type { ITerminal } from '@rushstack/terminal';
     dependsOnAdditionalFiles?: string[];
+    /**
+     * How many concurrency units this operation should take up during execution. The maximum concurrent units is
+     *  determined by the -p flag.
+     */
+    weight?: number;
 }
@@ -78,0 +83,0 @@ /**

lib/index.d.ts

@@ -32,3 +32,3 @@ /**
 export { ChangeManager } from './api/ChangeManager';
-export { LastInstallFlag as _LastInstallFlag, ILockfileValidityCheckOptions as _ILockfileValidityCheckOptions } from './api/LastInstallFlag';
+export { FlagFile as _FlagFile } from './api/FlagFile';
 export { VersionPolicyDefinitionName, BumpType, LockStepVersionPolicy, IndividualVersionPolicy, VersionPolicy } from './api/VersionPolicy';
@@ -35,0 +35,0 @@ export { VersionPolicyConfiguration } from './api/VersionPolicyConfiguration';

lib/logic/base/BaseInstallManagerTypes.d.ts

 import type { ITerminal } from '@rushstack/terminal';
 import type { Subspace } from '../../api/Subspace';
+import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 export interface IInstallManagerOptions {
@@ -70,3 +71,3 @@ /**
      */
-    pnpmFilterArguments: string[];
+    filteredProjects: RushConfigurationProject[];
     /**
@@ -73,0 +74,0 @@ * Callback to invoke between preparing the common/temp folder and running installation.

lib/logic/operations/AsyncOperationQueue.d.ts

@@ -11,3 +11,6 @@ import type { OperationExecutionRecord } from './OperationExecutionRecord';
 export declare const UNASSIGNED_OPERATION: 'UNASSIGNED_OPERATION';
-export type IOperationIteratorResult = OperationExecutionRecord | typeof UNASSIGNED_OPERATION;
+export type IOperationIteratorResult = OperationExecutionRecord | {
+    weight: 0;
+    status: typeof UNASSIGNED_OPERATION;
+};
 /**
@@ -14,0 +17,0 @@ * Implementation of the async iteration protocol for a collection of IOperation objects.

lib/logic/RushConstants.d.ts

@@ -259,3 +259,7 @@ /**
     static readonly projectImpactGraphFilename: 'project-impact-graph.yaml';
+    /**
+     * The filename for the last link flag
+     */
+    static readonly lastLinkFlagFilename: 'last-link';
 }
 //# sourceMappingURL=RushConstants.d.ts.map

lib/logic/UnlinkManager.d.ts

@@ -14,3 +14,3 @@ import type { RushConfiguration } from '../api/RushConfiguration';
      */
-    unlink(force?: boolean): boolean;
+    unlinkAsync(force?: boolean): Promise<boolean>;
     /**
@@ -17,0 +17,0 @@ * Delete:

lib/utilities/objectUtilities.d.ts

@@ -7,2 +7,7 @@ /**
 export declare function merge<TBase extends object, TOther>(base: TBase, other: TOther): (TBase & TOther) | TOther;
+/**
+ * Performs a partial deep comparison between `obj` and `source` to
+ * determine if `obj` contains equivalent property values.
+ */
+export declare function isMatch<TObject>(obj: TObject, source: TObject): boolean;
 //# sourceMappingURL=objectUtilities.d.ts.map

package.json

 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.122.1",
+  "version": "5.123.0",
   "description": "An API for interacting with the Rush engine",
@@ -28,4 +28,4 @@ "repository": {
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "4.1.0",
-    "@rushstack/terminal": "0.10.1"
+    "@rushstack/node-core-library": "4.2.0",
+    "@rushstack/terminal": "0.10.2"
   },
@@ -35,7 +35,7 @@ "devDependencies": {
     "@types/webpack-env": "1.18.0",
+    "@microsoft/rush-lib": "5.123.0",
+    "@rushstack/stream-collator": "4.1.42",
+    "@rushstack/heft": "0.66.4",
     "local-node-rig": "1.0.0",
-    "@microsoft/rush-lib": "5.122.1",
-    "@rushstack/stream-collator": "4.1.41",
-    "@rushstack/heft": "0.66.3",
-    "@rushstack/ts-command-line": "4.19.2"
+    "@rushstack/ts-command-line": "4.19.3"
   },
@@ -42,0 +42,0 @@ "scripts": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

680541

increased by0.28%

Number of package files

403

increased by0.5%

Lines of code

15075

increased by0.37%

Dependency changes

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

• + Added@rushstack/terminal@0.10.2(transitive)

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

• - Removed@rushstack/terminal@0.10.1(transitive)

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

• Updated@rushstack/terminal@0.10.2