@rushstack/rush-sdk 5.107.1 → 5.107.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2850,15 +2850,28 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
2850
2850
  */
2851
2851
  readonly pnpmStore: PnpmStoreLocation;
2852
2852
  /**
2853
- * This setting determines PNPM's `resolution-mode` option. The default value is `highest`.
2853
+ * This setting determines how PNPM chooses version numbers during `rush update`.
2854
2854
  *
2855
2855
  * @remarks
2856
- * Be aware that the PNPM 8 initially defaulted to `lowest` instead of `highest`, but PNPM
2857
- * reverted this decision in 8.6.12 because it caused confusion for users. Rush 5.106.0 and newer
2858
- * avoids this confusion by consistently defaulting to `highest` when `resolutionMode` is not
2859
- * explicitly set in pnpm-config.json or .npmrc, regardless of your PNPM version.
2856
+ * For example, suppose `lib-x@3.0.0` depends on `"lib-y": "^1.2.3"` whose latest major
2857
+ * releases are `1.8.9` and `2.3.4`. The resolution mode `lowest-direct` might choose
2858
+ * `lib-y@1.2.3`, wheres `highest` will choose 1.8.9, and `time-based` will pick the
2859
+ * highest compatible version at the time when `lib-x@3.0.0` itself was published (ensuring
2860
+ * that the version could have been tested by the maintainer of "lib-x"). For local workspace
2861
+ * projects, `time-based` instead works like `lowest-direct`, avoiding upgrades unless
2862
+ * they are explicitly requested. Although `time-based` is the most robust option, it may be
2863
+ * slightly slower with registries such as npmjs.com that have not implemented an optimization.
2864
+ *
2865
+ * IMPORTANT: Be aware that PNPM 8.0.0 initially defaulted to `lowest-direct` instead of
2866
+ * `highest`, but PNPM reverted this decision in 8.6.12 because it caused confusion for users.
2867
+ * Rush version 5.106.0 and newer avoids this confusion by consistently defaulting to
2868
+ * `highest` when `resolutionMode` is not explicitly set in pnpm-config.json or .npmrc,
2869
+ * regardless of your PNPM version.
2860
2870
  *
2861
2871
  * PNPM documentation: https://pnpm.io/npmrc#resolution-mode
2872
+ *
2873
+ * Possible values are: `highest`, `time-based`, and `lowest-direct`.
2874
+ * The default is `highest`.
2862
2875
  */
2863
2876
  readonly resolutionMode: PnpmResolutionMode | undefined;
2864
2877
  /**
@@ -3322,11 +3335,11 @@ export declare class RushConfiguration {
3322
3335
  */
3323
3336
  readonly currentVariantJsonFilename: string;
3324
3337
  /**
3325
- * The version of the locally installed NPM tool. (Example: "1.2.3")
3338
+ * The version of the locally package manager tool. (Example: "1.2.3")
3326
3339
  */
3327
3340
  readonly packageManagerToolVersion: string;
3328
3341
  /**
3329
- * The absolute path to the locally installed NPM tool. If "rush install" has not
3342
+ * The absolute path to the locally package manager tool. If "rush install" has not
3330
3343
  * been run, then this file may not exist yet.
3331
3344
  * Example: `C:\MyRepo\common\temp\npm-local\node_modules\.bin\npm`
3332
3345
  */
@@ -261,11 +261,11 @@ export declare class RushConfiguration {
261
261
  */
262
262
  readonly currentVariantJsonFilename: string;
263
263
  /**
264
- * The version of the locally installed NPM tool. (Example: "1.2.3")
264
+ * The version of the locally package manager tool. (Example: "1.2.3")
265
265
  */
266
266
  readonly packageManagerToolVersion: string;
267
267
  /**
268
- * The absolute path to the locally installed NPM tool. If "rush install" has not
268
+ * The absolute path to the locally package manager tool. If "rush install" has not
269
269
  * been run, then this file may not exist yet.
270
270
  * Example: `C:\MyRepo\common\temp\npm-local\node_modules\.bin\npm`
271
271
  */
@@ -116,15 +116,28 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
116
116
  */
117
117
  readonly pnpmStore: PnpmStoreLocation;
118
118
  /**
119
- * This setting determines PNPM's `resolution-mode` option. The default value is `highest`.
119
+ * This setting determines how PNPM chooses version numbers during `rush update`.
120
120
  *
121
121
  * @remarks
122
- * Be aware that the PNPM 8 initially defaulted to `lowest` instead of `highest`, but PNPM
123
- * reverted this decision in 8.6.12 because it caused confusion for users. Rush 5.106.0 and newer
124
- * avoids this confusion by consistently defaulting to `highest` when `resolutionMode` is not
125
- * explicitly set in pnpm-config.json or .npmrc, regardless of your PNPM version.
122
+ * For example, suppose `lib-x@3.0.0` depends on `"lib-y": "^1.2.3"` whose latest major
123
+ * releases are `1.8.9` and `2.3.4`. The resolution mode `lowest-direct` might choose
124
+ * `lib-y@1.2.3`, wheres `highest` will choose 1.8.9, and `time-based` will pick the
125
+ * highest compatible version at the time when `lib-x@3.0.0` itself was published (ensuring
126
+ * that the version could have been tested by the maintainer of "lib-x"). For local workspace
127
+ * projects, `time-based` instead works like `lowest-direct`, avoiding upgrades unless
128
+ * they are explicitly requested. Although `time-based` is the most robust option, it may be
129
+ * slightly slower with registries such as npmjs.com that have not implemented an optimization.
130
+ *
131
+ * IMPORTANT: Be aware that PNPM 8.0.0 initially defaulted to `lowest-direct` instead of
132
+ * `highest`, but PNPM reverted this decision in 8.6.12 because it caused confusion for users.
133
+ * Rush version 5.106.0 and newer avoids this confusion by consistently defaulting to
134
+ * `highest` when `resolutionMode` is not explicitly set in pnpm-config.json or .npmrc,
135
+ * regardless of your PNPM version.
126
136
  *
127
137
  * PNPM documentation: https://pnpm.io/npmrc#resolution-mode
138
+ *
139
+ * Possible values are: `highest`, `time-based`, and `lowest-direct`.
140
+ * The default is `highest`.
128
141
  */
129
142
  readonly resolutionMode: PnpmResolutionMode | undefined;
130
143
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rushstack/rush-sdk",
3
- "version": "5.107.1",
3
+ "version": "5.107.3",
4
4
  "description": "An API for interacting with the Rush engine",
5
5
  "repository": {
6
6
  "type": "git",
@@ -30,13 +30,13 @@
30
30
  "devDependencies": {
31
31
  "@types/semver": "7.5.0",
32
32
  "@types/webpack-env": "1.18.0",
33
- "@microsoft/rush-lib": "5.107.1",
33
+ "@microsoft/rush-lib": "5.107.3",
34
34
  "@rushstack/eslint-config": "3.3.4",
35
- "@rushstack/heft": "0.60.0",
35
+ "@rushstack/heft": "0.61.0",
36
36
  "local-node-rig": "1.0.0",
37
- "@rushstack/stream-collator": "4.1.2",
37
+ "@rushstack/stream-collator": "4.1.3",
38
38
  "@rushstack/ts-command-line": "4.16.0",
39
- "@rushstack/terminal": "0.7.1"
39
+ "@rushstack/terminal": "0.7.2"
40
40
  },
41
41
  "scripts": {
42
42
  "build": "heft build --clean",