@rushstack/rush-sdk 5.89.0 → 5.90.0

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.
Files changed (2) hide show
  1. package/dist/rush-lib.d.ts +21 -6
  2. package/package.json +11 -11
@@ -1224,14 +1224,14 @@ export declare interface IPhase {
1224
1224
  */
1225
1225
  name: string;
1226
1226
  /**
1227
- * If set to "true," this this phase was generated from a bulk command, and
1227
+ * If set to `true,` this this phase was generated from a bulk command, and
1228
1228
  * was not explicitly defined in the command-line.json file.
1229
1229
  */
1230
1230
  isSynthetic: boolean;
1231
1231
  /**
1232
1232
  * This property is used in the name of the filename for the logs generated by this
1233
1233
  * phase. This is a filesystem-safe version of the phase name. For example,
1234
- * a phase with name "_phase:compile" has a `logFilenameIdentifier` of "_phase_compile".
1234
+ * a phase with name `_phase:compile` has a `logFilenameIdentifier` of `_phase_compile`.
1235
1235
  */
1236
1236
  logFilenameIdentifier: string;
1237
1237
  /**
@@ -1246,13 +1246,24 @@ export declare interface IPhase {
1246
1246
  upstream: Set<IPhase>;
1247
1247
  };
1248
1248
  /**
1249
- * 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.
1249
+ * Normally Rush requires that each project's package.json has a `"scripts"` entry matching the phase name.
1250
+ * To disable this check, set `ignoreMissingScript` to true.
1250
1251
  */
1251
1252
  ignoreMissingScript: boolean;
1252
1253
  /**
1253
- * 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.
1254
+ * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is
1255
+ * set to `true`, Rush will return a zero exit code if warnings occur during the execution of this phase.
1254
1256
  */
1255
1257
  allowWarningsOnSuccess: boolean;
1258
+ /**
1259
+ * (Optional) If the `shellCommand` field is set for a bulk command, Rush will invoke it for each
1260
+ * selected project; otherwise, Rush will invoke the package.json `"scripts"` entry matching Rush command/phase name.
1261
+ *
1262
+ * This string is the path to a script that will be invoked using the OS shell. The working directory will be
1263
+ * the folder that contains rush.json. If custom parameters are associated with this command, their
1264
+ * values will be appended to the end of this string.
1265
+ */
1266
+ shellCommand?: string;
1256
1267
  }
1257
1268
 
1258
1269
  /**
@@ -2041,7 +2052,10 @@ export declare class PackageJsonEditor {
2041
2052
  private _modified;
2042
2053
  private _sourceData;
2043
2054
  readonly filePath: string;
2044
- private constructor();
2055
+ /**
2056
+ * @internal
2057
+ */
2058
+ protected constructor(filepath: string, data: IPackageJson);
2045
2059
  static load(filePath: string): PackageJsonEditor;
2046
2060
  static fromObject(object: IPackageJson, filename: string): PackageJsonEditor;
2047
2061
  get name(): string;
@@ -2961,6 +2975,7 @@ export declare class RushConfigurationProject {
2961
2975
  private _versionPolicy;
2962
2976
  private _dependencyProjects;
2963
2977
  private _consumingProjects;
2978
+ private _packageJson;
2964
2979
  /**
2965
2980
  * The name of the NPM package. An error is reported if this name is not
2966
2981
  * identical to packageJson.name.
@@ -3012,7 +3027,7 @@ export declare class RushConfigurationProject {
3012
3027
  /**
3013
3028
  * The parsed NPM "package.json" file from projectFolder.
3014
3029
  */
3015
- readonly packageJson: IPackageJson;
3030
+ get packageJson(): IPackageJson;
3016
3031
  /**
3017
3032
  * A useful wrapper around the package.json file for making modifications
3018
3033
  * @beta
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rushstack/rush-sdk",
3
- "version": "5.89.0",
3
+ "version": "5.90.0",
4
4
  "description": "An API for interacting with the Rush engine",
5
5
  "repository": {
6
6
  "type": "git",
@@ -12,21 +12,21 @@
12
12
  "typings": "dist/rush-lib.d.ts",
13
13
  "license": "MIT",
14
14
  "dependencies": {
15
- "@rushstack/node-core-library": "3.53.3",
16
15
  "@types/node-fetch": "1.6.9",
17
- "tapable": "2.2.1"
16
+ "tapable": "2.2.1",
17
+ "@rushstack/node-core-library": "3.53.3"
18
18
  },
19
19
  "devDependencies": {
20
- "@microsoft/rush-lib": "5.89.0",
21
- "@rushstack/eslint-config": "3.1.1",
22
- "@rushstack/heft": "0.49.1",
23
- "@rushstack/heft-node-rig": "1.11.12",
24
- "@rushstack/stream-collator": "4.0.220",
25
- "@rushstack/ts-command-line": "4.13.1",
26
- "@rushstack/terminal": "0.3.89",
27
20
  "@types/heft-jest": "1.0.1",
28
21
  "@types/semver": "7.3.5",
29
- "@types/webpack-env": "1.13.0"
22
+ "@types/webpack-env": "1.13.0",
23
+ "@microsoft/rush-lib": "5.90.0",
24
+ "@rushstack/eslint-config": "3.1.1",
25
+ "@rushstack/heft": "0.49.3",
26
+ "@rushstack/heft-node-rig": "1.11.14",
27
+ "@rushstack/stream-collator": "4.0.222",
28
+ "@rushstack/ts-command-line": "4.13.1",
29
+ "@rushstack/terminal": "0.3.91"
30
30
  },
31
31
  "scripts": {
32
32
  "build": "heft build --clean",