rename parms

pcoop · pcoop · commit b10aff378568 · 2019-05-15T15:40:55.000+01:00
diff --git a/docs-internal/CLIReadme.md b/docs-internal/CLIReadme.md
diff --git a/src/cli/deploy/bundle/DeployBundle.definition.ts b/src/cli/deploy/bundle/DeployBundle.definition.ts
@@ -44,16 +44,16 @@ export const DeployBundleDefinition: ICommandDefinition = {
     examples: [
         {
             description: "Deploy a CICS bundle with a specific name and location to a default set of target regions",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir`
+            options: `--name EXAMPLE --bundle-directory /u/example/bundleDir`
         },
         {
             description: "Deploy a CICS bundle, but declare a timeout if the processing takes too long",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir --timeout 60`
+            options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --timeout 60`
         },
         {
             description: "Deploy a CICS bundle to a specific target environment by using specific zosmf & cics-deploy profiles",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
-                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
+            options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --res-group BUNDGRP ` +
+                     `--cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
         }
     ]
 };
diff --git a/src/cli/deploy/bundle/options/Bundledir.option.ts b/src/cli/deploy/bundle/options/Bundledir.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 255;
  *
  */
 export const BundledirOption: ICommandOptionDefinition = {
-    name: "bundledir",
-    aliases: ["bd"],
+    name: "bundle-directory",
+    aliases: ["bd", "bundledir"],
     type: "string",
     required: true,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/deploy/bundle/options/TargetState.option.ts b/src/cli/deploy/bundle/options/TargetState.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const TargetStateOption: ICommandOptionDefinition = {
-    name: "targetstate",
-    aliases: ["ts"],
+    name: "target-state",
+    aliases: ["ts", "targetstate"],
     type: "string",
     required: false,
     defaultValue: "ENABLED",
diff --git a/src/cli/generate/bundle/GenerateBundle.definition.ts b/src/cli/generate/bundle/GenerateBundle.definition.ts
@@ -41,11 +41,11 @@ export const GenerateBundleDefinition: ICommandDefinition = {
         },
         {
             description: "Generate a CICS bundle in the working directory, based on package.json but using a bundle ID of \"mybundle\"",
-            options: `--bundleid mybundle`
+            options: `--bundle-id mybundle`
         },
         {
             description: "Generate a CICS bundle in the working directory in which a package.json does not exist",
-            options: `--bundleid mybundle --nodejsapp myapp --startscript server.js`
+            options: `--bundle-id mybundle --nodejsapp myapp --start-script server.js`
         }
     ]
 };
diff --git a/src/cli/generate/bundle/options/Bundleid.option.ts b/src/cli/generate/bundle/options/Bundleid.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const BundleidOption: ICommandOptionDefinition = {
-    name: "bundleid",
-    aliases: ["b", "id", "bid"],
+    name: "bundle-id",
+    aliases: ["b", "id", "bundleid"],
     type: "string",
     description: "The ID for the generated CICS bundle, up to 64 characters. If no value is " +
                  "specified, a default value is created from the 'name' property " +
diff --git a/src/cli/generate/bundle/options/Bundleversion.option.ts b/src/cli/generate/bundle/options/Bundleversion.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const BundleversionOption: ICommandOptionDefinition = {
-    name: "bundleversion",
-    aliases: ["bv", "bundlever"],
+    name: "bundle-version",
+    aliases: ["bv", "bundleversion"],
     type: "string",
     description: "The major.minor.micro version number for the generated CICS bundle. If no value is " +
                  "specified, a default value of 1.0.0 is used."
diff --git a/src/cli/generate/bundle/options/Startscript.option.ts b/src/cli/generate/bundle/options/Startscript.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const StartscriptOption: ICommandOptionDefinition = {
-    name: "startscript",
-    aliases: ["s", "ss"],
+    name: "start-script",
+    aliases: ["s", "ss", "startscript"],
     type: "string",
     description: "Up to 255 character path to the Node.js start script that runs when " +
                  "the associated bundle is enabled in CICS. If a value is not " +
diff --git a/src/cli/push/bundle/PushBundle.definition.ts b/src/cli/push/bundle/PushBundle.definition.ts
@@ -43,15 +43,15 @@ export const PushBundleDefinition: ICommandDefinition = {
     examples: [
         {
             description: "Push a CICS bundle from the working directory by using default cics-deploy, ssh and zosmf profiles",
-            options: `--name EXAMPLE --targetdir /u/example/bundles`
+            options: `--name EXAMPLE --target-directory /u/example/bundles`
         },
         {
             description: "Push a CICS bundle from the working directory by using specific zosmf, ssh & cics-deploy profiles",
-            options: `--name EXAMPLE --targetdir /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh`
+            options: `--name EXAMPLE --target-directory /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh`
         },
         {
             description: "Push a CICS bundle from the working directory replacing any bundle of the same name that is already deployed",
-            options: `--name EXAMPLE --targetdir /u/example/bundles --overwrite`
+            options: `--name EXAMPLE --target-directory /u/example/bundles --overwrite`
         }
     ]
 };
diff --git a/src/cli/push/bundle/options/Targetdir.option.ts b/src/cli/push/bundle/options/Targetdir.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 255;
  *
  */
 export const TargetdirOption: ICommandOptionDefinition = {
-    name: "targetdir",
-    aliases: ["td"],
+    name: "target-directory",
+    aliases: ["td", "targetdir"],
     type: "string",
     required: true,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/shared/Cicshlq.option.ts b/src/cli/shared/Cicshlq.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 35;
  *
  */
 export const CicshlqOption: ICommandOptionDefinition = {
-    name: "cicshlq",
-    aliases: ["hlq"],
+    name: "cics-hlq",
+    aliases: ["ch", "cicshlq"],
     type: "string",
     required: false,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/shared/Cpsmhlq.option.ts b/src/cli/shared/Cpsmhlq.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 35;
  *
  */
 export const CpsmhlqOption: ICommandOptionDefinition = {
-    name: "cpsmhlq",
-    aliases: ["cphlq"],
+    name: "cpsm-hlq",
+    aliases: ["cph", "cpsmhlq"],
     type: "string",
     required: false,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/shared/Csdgroup.option.ts b/src/cli/shared/Csdgroup.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 8;
  *
  */
 export const CsdgroupOption: ICommandOptionDefinition = {
-    name: "csdgroup",
-    aliases: ["cg"],
+    name: "csd-group",
+    aliases: ["cg", "csdgroup"],
     type: "string",
     stringLengthRange: [1, MAX_LENGTH],
     description: "Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is " +
diff --git a/src/cli/shared/Jobcard.option.ts b/src/cli/shared/Jobcard.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const JobcardOption: ICommandOptionDefinition = {
-    name: "jobcard",
-    aliases: ["jc"],
+    name: "job-card",
+    aliases: ["jc", "jobcard"],
     type: "string",
     description: "Specifies the job card to use with any generated DFHDPLOY JCL. Use this parameter " +
                  "if you need to tailor the job card and you have not set the --cics-deploy-profile " +
diff --git a/src/cli/shared/Resgroup.option.ts b/src/cli/shared/Resgroup.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 8;
  *
  */
 export const ResgroupOption: ICommandOptionDefinition = {
-    name: "resgroup",
-    aliases: ["rg"],
+    name: "res-group",
+    aliases: ["rg", "resgroup"],
     type: "string",
     stringLengthRange: [1, MAX_LENGTH],
     conflictsWith: [ "csdgroup" ],
diff --git a/src/cli/undeploy/bundle/UndeployBundle.definition.ts b/src/cli/undeploy/bundle/UndeployBundle.definition.ts
@@ -50,8 +50,8 @@ export const UndeployBundleDefinition: ICommandDefinition = {
         },
         {
             description: "Undeploy a CICS bundle from a specific target environment by using specific zosmf and cics-deploy profiles",
-            options: `--name EXAMPLE --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
-                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
+            options: `--name EXAMPLE --cics-plex TESTPLEX --scope SCOPE --res-group BUNDGRP ` +
+                     `--cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
         }
     ]
 };
diff --git a/src/cli/undeploy/bundle/options/TargetState.option.ts b/src/cli/undeploy/bundle/options/TargetState.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const TargetStateOption: ICommandOptionDefinition = {
-    name: "targetstate",
-    aliases: ["ts"],
+    name: "target-state",
+    aliases: ["ts", "targetstate"],
     type: "string",
     required: false,
     defaultValue: "DISCARDED",
diff --git a/src/imperative.ts b/src/imperative.ts
@@ -63,8 +63,8 @@ const config: IImperativeConfig = {
                              "that is specified by the --scope option. The --csdgroup and --resgroup options are " +
                              "mutually exclusive.",
                 type: "string",
-                name: "csdgroup",
-                aliases: ["cg"],
+                name: "csd-group",
+                aliases: ["cg", "csdgroup"],
                 stringLengthRange: [1, MAX_LENGTH]
               },
               type: "string"
@@ -75,8 +75,8 @@ const config: IImperativeConfig = {
                              "deployed then a resource is defined in the BAS data repository; if a bundle is undeployed then the " +
                              "definition is removed. The --csdgroup and --resgroup options are mutually exclusive.",
                 type: "string",
-                name: "resgroup",
-                aliases: ["rg"],
+                name: "res-group",
+                aliases: ["rg", "resgroup"],
                 stringLengthRange: [1, MAX_LENGTH],
                 conflictsWith: [ "csdgroup" ],
               },
@@ -87,8 +87,8 @@ const config: IImperativeConfig = {
                 description: "Specifies the High Level Qualifier (up to 35 characters) at which the CICS " +
                              "datasets can be found in the target environment.",
                 type: "string",
-                name: "cicshlq",
-                aliases: ["hlq"],
+                name: "cics-hlq",
+                aliases: ["ch", "cicshlq"],
                 stringLengthRange: [1, MAX_HLQ_LENGTH],
                 required: true
               },
@@ -99,8 +99,8 @@ const config: IImperativeConfig = {
                 description: "Specifies the High Level Qualifier (up to 35 characters) at which the CPSM " +
                              "datasets can be found in the target environment.",
                 type: "string",
-                name: "cpsmhlq",
-                aliases: ["cphlq"],
+                name: "cpsm-hlq",
+                aliases: ["cph", "cpsmhlq"],
                 stringLengthRange: [1, MAX_HLQ_LENGTH],
                 required: true
               },
@@ -110,8 +110,8 @@ const config: IImperativeConfig = {
               optionDefinition: {
                 description: "Specifies the target zFS location to which CICS bundles should be uploaded (up to 255 characters).",
                 type: "string",
-                name: "targetdir",
-                aliases: ["td"],
+                name: "target-directory",
+                aliases: ["td", "targetdir"],
                 stringLengthRange: [1, MAX_TARGETDIR_LENGTH],
                 required: false
               },
@@ -121,9 +121,9 @@ const config: IImperativeConfig = {
               optionDefinition: {
                 description: "Specifies the job card to use with any generated DFHDPLOY JCL.",
                 type: "string",
-                name: "jobcard",
+                name: "job-card",
                 defaultValue: "//DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT",
-                aliases: ["jc"],
+                aliases: ["jc", "jobcard"],
                 required: true
               },
               type: "string"
@@ -133,18 +133,18 @@ const config: IImperativeConfig = {
         },
         createProfileExamples: [
           {
-            options: "example1 --cicsplex PLEX1 --scope TESTGRP1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550",
+            options: "example1 --cicsplex PLEX1 --scope TESTGRP1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550",
             description: "Create a cics-deploy profile called 'example1' to connect to a CPSM managed group of CICS regions " +
                          "within the TESTGRP1 scope of a cicsplex named PLEX1"
           },
           {
-            options: "example2 --cicsplex PLEX1 --scope TESTGRP1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --resgroup BUNDGRP1",
+            options: "example2 --cicsplex PLEX1 --scope TESTGRP1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --res-group BUNDGRP1",
             description: "Create a cics-deploy profile called 'example2' to connect to the same CPSM managed group of regions, " +
                          "and identify a BAS resource group BUNDGRP1 in which to store resource definitions"
           },
           {
-            options: "example3 --cicsplex PLEX1 --scope TESTGRP1 --cicshlq CICSTS55.CICS720 " +
-                     "--cpsmhlq CICSTS55.CPSM550 --targetdir /var/cicsts/bundles",
+            options: "example3 --cicsplex PLEX1 --scope TESTGRP1 --cics-hlq CICSTS55.CICS720 " +
+                     "--cpsm-hlq CICSTS55.CPSM550 --target-directory /var/cicsts/bundles",
             description: "Create a cics-deploy profile called 'example3' to connect to the same CPSM managed group of regions, " +
                          "and identify the default USS directory to which bundles should be uploaded"
           }

Original file line number	Diff line number	Diff line change
`@@ -44,16 +44,16 @@ export const DeployBundleDefinition: ICommandDefinition = {`
`44`	`44`	`examples: [`
`45`	`45`	`{`
`46`	`46`	`description: "Deploy a CICS bundle with a specific name and location to a default set of target regions",`
`47`		- options: `--name EXAMPLE --bundledir /u/example/bundleDir`
	`47`	+ options: `--name EXAMPLE --bundle-directory /u/example/bundleDir`
`48`	`48`	`},`
`49`	`49`	`{`
`50`	`50`	`description: "Deploy a CICS bundle, but declare a timeout if the processing takes too long",`
`51`		- options: `--name EXAMPLE --bundledir /u/example/bundleDir --timeout 60`
	`51`	+ options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --timeout 60`
`52`	`52`	`},`
`53`	`53`	`{`
`54`	`54`	`description: "Deploy a CICS bundle to a specific target environment by using specific zosmf & cics-deploy profiles",`
`55`		- options: `--name EXAMPLE --bundledir /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
`56`		- `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
	`55`	+ options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --res-group BUNDGRP ` +
	`56`	+ `--cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
`57`	`57`	`}`
`58`	`58`	`]`
`59`	`59`	`};`
Original file line number	Diff line number	Diff line change
`@@ -41,11 +41,11 @@ export const GenerateBundleDefinition: ICommandDefinition = {`
`41`	`41`	`},`
`42`	`42`	`{`
`43`	`43`	`description: "Generate a CICS bundle in the working directory, based on package.json but using a bundle ID of \"mybundle\"",`
`44`		- options: `--bundleid mybundle`
	`44`	+ options: `--bundle-id mybundle`
`45`	`45`	`},`
`46`	`46`	`{`
`47`	`47`	`description: "Generate a CICS bundle in the working directory in which a package.json does not exist",`
`48`		- options: `--bundleid mybundle --nodejsapp myapp --startscript server.js`
	`48`	+ options: `--bundle-id mybundle --nodejsapp myapp --start-script server.js`
`49`	`49`	`}`
`50`	`50`	`]`
`51`	`51`	`};`
Original file line number	Diff line number	Diff line change
`@@ -43,15 +43,15 @@ export const PushBundleDefinition: ICommandDefinition = {`
`43`	`43`	`examples: [`
`44`	`44`	`{`
`45`	`45`	`description: "Push a CICS bundle from the working directory by using default cics-deploy, ssh and zosmf profiles",`
`46`		- options: `--name EXAMPLE --targetdir /u/example/bundles`
	`46`	+ options: `--name EXAMPLE --target-directory /u/example/bundles`
`47`	`47`	`},`
`48`	`48`	`{`
`49`	`49`	`description: "Push a CICS bundle from the working directory by using specific zosmf, ssh & cics-deploy profiles",`
`50`		- options: `--name EXAMPLE --targetdir /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh`
	`50`	+ options: `--name EXAMPLE --target-directory /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh`
`51`	`51`	`},`
`52`	`52`	`{`
`53`	`53`	`description: "Push a CICS bundle from the working directory replacing any bundle of the same name that is already deployed",`
`54`		- options: `--name EXAMPLE --targetdir /u/example/bundles --overwrite`
	`54`	+ options: `--name EXAMPLE --target-directory /u/example/bundles --overwrite`
`55`	`55`	`}`
`56`	`56`	`]`
`57`	`57`	`};`