@rushstack/rush-sdk - npm Package Compare versions

Comparing version 5.112.1 to 5.112.2

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.38.3"
+      "packageVersion": "7.38.5"
     }
   ]
 }

lib/api/RushConfiguration.d.ts

@@ -17,2 +17,3 @@ import { type JsonNull, type PackageNameParser } from '@rushstack/node-core-library';
 import { CustomTipsConfiguration } from './CustomTipsConfiguration';
+import { SubspaceConfiguration } from './SubspaceConfiguration';
 /**
@@ -123,2 +124,11 @@ * Part of IRushConfigurationJson.
 /**
+ * The filter parameters to search from all projects
+ */
+export interface IRushConfigurationProjectsFilter {
+    /**
+     * A string representation of the subspace to filter for
+     */
+    subspace: string;
+}
+/**
  * Options for `RushConfiguration.tryFindRushJsonLocation`.
@@ -149,2 +159,3 @@ * @public
     private _projectsByTag;
+    private _rushProjectsBySubspaceName;
     private _commonVersionsConfigurationsByVariant;
@@ -259,2 +270,7 @@ /**
     /**
+     * The object that specifies subspace configurations if they are provided in the rush workspace.
+     * @beta
+     */
+    readonly subspaceConfiguration?: SubspaceConfiguration;
+    /**
      * The filename of the variant dependency data file.  By default this is
@@ -498,2 +514,21 @@ * called 'current-variant.json' resides in the Rush common folder.
     /**
+     * Returns full path of the temporary shrinkwrap file for a specific subspace.
+     * @remarks
+     * This function takes the subspace name, and returns the full path for the subspace's shrinkwrap file.
+     * This function also consults the deprecated option to allow for shrinkwraps to be stored under a package folder.
+     * This shrinkwrap file is used during "rush install", and may be rewritten by the package manager during installation
+     * This property merely reports the filename, the file itself may not actually exist.
+     * example: `C:\MyRepo\common\<subspace_name>\pnpm-lock.yaml`
+     * @beta
+     */
+    getTempSubspaceShrinkwrapFileName(subspaceName: string): string;
+    /**
+     * The filename (without any path) of the shrinkwrap file used for individual subspaces, used by the package manager.
+     * @remarks
+     * This property merely reports the filename; The file itself may not actually exist.
+     * Example: From "pnpm-lock.yaml" to "subspace-pnpm-lock.yaml"
+     * @beta
+     */
+    subspaceShrinkwrapFilenames(subspaceName: string): string;
+    /**
      * Returns an English phrase such as "shrinkwrap file" that can be used in logging messages
@@ -520,2 +555,10 @@ * to refer to the shrinkwrap file using appropriate terminology for the currently selected
     get projects(): RushConfigurationProject[];
+    /**
+     * A list of all the available subspaces in this workspace.
+     * @beta
+     */
+    get subspaceNames(): Iterable<string>;
+    /**
+     * @beta
+     */
     get projectsByName(): Map<string, RushConfigurationProject>;
@@ -551,2 +594,8 @@ /**
     /**
+     * Returns `true` if the subspaces feature is enabled and at least one subspaces is defined
+     * in the `subspaces.json` config file.
+     * @beta
+     */
+    get hasSubspaces(): boolean;
+    /**
      * Gets the settings from the common-versions.json config file for a specific variant.
@@ -553,0 +602,0 @@ * @param variant - The name of the current variant in use by the active command.

lib/api/RushConfigurationProject.d.ts

@@ -19,2 +19,3 @@ import { type IPackageJson } from '@rushstack/node-core-library';
     tags?: string[];
+    subspaceName?: string;
 }
@@ -155,2 +156,14 @@ /**
     readonly tags: ReadonlySet<string>;
+    /**
+     * Returns the name of the subspace that this project belongs to, as assigned by the `"subspaceName"`
+     * property in `rush.json`.
+     *
+     * @remarks
+     * If the Rush subspaces feature is disabled, the value is still return.
+     * When the Rush subspaces feature is enabled, an undefined `subspaceName` specifies that
+     * the project belongs to the default subspace (whose name is `"default"`).
+     *
+     * @beta
+     */
+    readonly subspaceName: string | undefined;
     /** @internal */
@@ -157,0 +170,0 @@ constructor(options: IRushConfigurationProjectOptions);

lib/api/VersionPolicy.d.ts

@@ -7,2 +7,9 @@ import { type IPackageJson } from '@rushstack/node-core-library';
  * @public
+ *
+ * @internalRemarks
+ * This is a copy of the semver ReleaseType enum, but with the `none` value added and
+ * the `premajor` and `prepatch` omitted.
+ * See {@link LockStepVersionPolicy._getReleaseType}.
+ *
+ * TODO: Consider supporting `premajor` and `prepatch` in the future.
  */
@@ -13,2 +20,3 @@ export declare enum BumpType {
     'patch' = 2,
+    'preminor' = 3,
     'minor' = 4,
@@ -15,0 +23,0 @@ 'major' = 5

lib/cli/actions/InitAction.d.ts

@@ -6,2 +6,3 @@ import type { RushCommandLineParser } from '../RushCommandLineParser';
     private readonly _rushExampleParameter;
+    private readonly _experimentsParameter;
     private _commentedBySectionName;
@@ -8,0 +9,0 @@ constructor(parser: RushCommandLineParser);

lib/index.d.ts

@@ -7,2 +7,3 @@ /**
 export { RushConfiguration, ITryFindRushJsonLocationOptions } from './api/RushConfiguration';
+export { SubspaceConfiguration } from './api/SubspaceConfiguration';
 export { IPackageManagerOptionsJsonBase, IConfigurationEnvironment, IConfigurationEnvironmentVariable, PackageManagerOptionsConfigurationBase } from './logic/base/BasePackageManagerOptionsConfiguration';
@@ -9,0 +10,0 @@ export { INpmOptionsJson as _INpmOptionsJson, NpmOptionsConfiguration } from './logic/npm/NpmOptionsConfiguration';

lib/logic/PublishUtilities.d.ts

@@ -46,3 +46,2 @@ import { type IPackageJson } from '@rushstack/node-core-library';
     private static _getReleaseType;
-    private static _getChangeTypeForSemverReleaseType;
     private static _getNewRangeDependency;
@@ -49,0 +48,0 @@ private static _shouldSkipVersionBump;

lib/logic/RushConstants.d.ts

@@ -149,2 +149,6 @@ /**
     /**
+     * The subspaces.json configuration file name
+     */
+    static readonly subspacesConfigFilename: string;
+    /**
      * Build cache configuration file.
@@ -151,0 +155,0 @@ */

package.json

 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.112.1",
+  "version": "5.112.2",
   "description": "An API for interacting with the Rush engine",
@@ -28,3 +28,3 @@ "repository": {
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "3.61.0"
+    "@rushstack/node-core-library": "3.62.0"
   },
@@ -34,8 +34,8 @@ "devDependencies": {
     "@types/webpack-env": "1.18.0",
-    "@rushstack/heft": "0.63.2",
-    "@microsoft/rush-lib": "5.112.1",
+    "@microsoft/rush-lib": "5.112.2",
+    "@rushstack/heft": "0.63.4",
     "local-node-rig": "1.0.0",
-    "@rushstack/stream-collator": "4.1.13",
+    "@rushstack/terminal": "0.7.14",
     "@rushstack/ts-command-line": "4.17.1",
-    "@rushstack/terminal": "0.7.12"
+    "@rushstack/stream-collator": "4.1.15"
   },
@@ -42,0 +42,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

649104

increased by1.17%

Number of package files

395

increased by0.51%

Lines of code

14293

increased by1.3%

Dependency changes

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

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

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