Rename "scriptPath" to "shellCommand"

pgonzal · pgonzal · commit 4e5ceb8a310a · 2018-06-08T15:46:16.000-07:00
diff --git a/apps/rush-lib/src/api/CommandLineJson.ts b/apps/rush-lib/src/api/CommandLineJson.ts
@@ -25,7 +25,7 @@ export interface IBulkCommandJson extends IBaseCommandJson {
  */
 export interface IGlobalCommandJson extends IBaseCommandJson {
   commandKind: 'global';
-  scriptPath: string;
+  shellCommand: string;
 }
 
 export type CommandJson = IBulkCommandJson | IGlobalCommandJson;
diff --git a/apps/rush-lib/src/cli/RushCommandLineParser.ts b/apps/rush-lib/src/cli/RushCommandLineParser.ts
@@ -189,7 +189,7 @@ export class RushCommandLineParser extends CommandLineParser {
             parser: this,
             commandLineConfiguration: commandLineConfiguration,
 
-            scriptPath: command.scriptPath
+            shellCommand: command.shellCommand
           }));
           break;
         default:
diff --git a/apps/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts b/apps/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts
@@ -13,7 +13,7 @@ import { AlreadyReportedError } from '../../../lib/utilities/AlreadyReportedErro
  * Constructor parameters for GlobalScriptAction.
  */
 export interface IGlobalScriptActionOptions extends IBaseScriptActionOptions {
-  scriptPath: string;
+  shellCommand: string;
 }
 
 /**
@@ -27,13 +27,13 @@ export interface IGlobalScriptActionOptions extends IBaseScriptActionOptions {
  * invoke scripts from package.json in the same way as a custom command.
  */
 export class GlobalScriptAction extends BaseScriptAction {
-  private _scriptPath: string;
+  private _shellCommand: string;
 
   constructor(
     options: IGlobalScriptActionOptions
   ) {
     super(options);
-    this._scriptPath = options.scriptPath;
+    this._shellCommand = options.shellCommand;
   }
 
   public run(): Promise<void> {
@@ -50,7 +50,7 @@ export class GlobalScriptAction extends BaseScriptAction {
         customParameter.appendToArgList(customParameterValues);
       }
 
-      let shellCommand: string = this._scriptPath;
+      let shellCommand: string = this._shellCommand;
       if (customParameterValues.length > 0) {
         shellCommand += ' ' + customParameterValues.join(' ');
       }
diff --git a/apps/rush-lib/src/cli/test/repo/common/config/rush/command-line.json b/apps/rush-lib/src/cli/test/repo/common/config/rush/command-line.json
@@ -12,7 +12,7 @@
       "commandKind": "global",
       "summary": "Deploys the build",
       "description": "Uploads all the built assets to the CDN",
-      "scriptPath": "node common/scripts/deploy.js"
+      "shellCommand": "node common/scripts/deploy.js"
     }
   ],
 
diff --git a/apps/rush-lib/src/schemas/command-line.schema.json b/apps/rush-lib/src/schemas/command-line.schema.json
@@ -94,14 +94,14 @@
         {
           "type": "object",
           "additionalProperties": true,
-          "required": [ "scriptPath" ],
+          "required": [ "shellCommand" ],
           "properties": {
             "commandKind": {
               "enum": [ "global" ]
             },
-            "scriptPath": {
-              "title": "Script Path",
-              "description": "The relative path to a JavaScript file that will be invoked using the NodeJS engine.  The path is relative to the repository root folder that contains rush.json.",
+            "shellCommand": {
+              "title": "Shell Command",
+              "description": "A command that that will be invoked using the OS shell. The working directory will be the folder that contains rush.json. Additional command-line parameters may be appended to the end of this string.",
               "type": "string"
             }
           }
@@ -115,7 +115,7 @@
             "summary": { "$ref": "#/definitions/anything" },
             "description": { "$ref": "#/definitions/anything" },
 
-            "scriptPath": { "$ref": "#/definitions/anything" }
+            "shellCommand": { "$ref": "#/definitions/anything" }
           }
         }
       ]

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export interface IBulkCommandJson extends IBaseCommandJson {`
`25`	`25`	`*/`
`26`	`26`	`export interface IGlobalCommandJson extends IBaseCommandJson {`
`27`	`27`	`commandKind: 'global';`
`28`		`- scriptPath: string;`
	`28`	`+ shellCommand: string;`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`export type CommandJson = IBulkCommandJson \| IGlobalCommandJson;`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`"commandKind": "global",`
`13`	`13`	`"summary": "Deploys the build",`
`14`	`14`	`"description": "Uploads all the built assets to the CDN",`
`15`		`- "scriptPath": "node common/scripts/deploy.js"`
	`15`	`+ "shellCommand": "node common/scripts/deploy.js"`
`16`	`16`	`}`
`17`	`17`	`],`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -94,14 +94,14 @@`
`94`	`94`	`{`
`95`	`95`	`"type": "object",`
`96`	`96`	`"additionalProperties": true,`
`97`		`- "required": [ "scriptPath" ],`
	`97`	`+ "required": [ "shellCommand" ],`
`98`	`98`	`"properties": {`
`99`	`99`	`"commandKind": {`
`100`	`100`	`"enum": [ "global" ]`
`101`	`101`	`},`
`102`		`- "scriptPath": {`
`103`		`- "title": "Script Path",`
`104`		`- "description": "The relative path to a JavaScript file that will be invoked using the NodeJS engine. The path is relative to the repository root folder that contains rush.json.",`
	`102`	`+ "shellCommand": {`
	`103`	`+ "title": "Shell Command",`
	`104`	`+ "description": "A command that that will be invoked using the OS shell. The working directory will be the folder that contains rush.json. Additional command-line parameters may be appended to the end of this string.",`
`105`	`105`	`"type": "string"`
`106`	`106`	`}`
`107`	`107`	`}`
`@@ -115,7 +115,7 @@`
`115`	`115`	`"summary": { "$ref": "#/definitions/anything" },`
`116`	`116`	`"description": { "$ref": "#/definitions/anything" },`
`117`	`117`
`118`		`- "scriptPath": { "$ref": "#/definitions/anything" }`
	`118`	`+ "shellCommand": { "$ref": "#/definitions/anything" }`
`119`	`119`	`}`
`120`	`120`	`}`
`121`	`121`	`]`