Merge pull request #1991 from zowe/cap-and-punctuation

Normalize capitalization and punctuation in command descriptions and summaries
zowe · Jan 3, 2024 · 879e8cb · 879e8cb
2 parents af15e5b + 6f30932
commit 879e8cb
Show file tree

Hide file tree

Showing 193 changed files with 523 additions and 406 deletions.
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the Zowe CLI package will be documented in this file.
 
+## Recent Changes
+
+- Enhancement: Revised help text for consistency [#1756](https://github.com/zowe/zowe-cli/issues/1756)
+
 ## `8.0.0-next.202401022112`
 
 - BugFix: Add missing npm-shrinkwrap

diff --git a/...fig/auto-init/__integration__/__snapshots__/cli.config.auto-init.integration.test.ts.snap b/...fig/auto-init/__integration__/__snapshots__/cli.config.auto-init.integration.test.ts.snap
@@ -10,7 +10,7 @@ exports[`config auto-init help should display help 1`] = `
  DESCRIPTION
  -----------
 
-   Automatically generate a config from APIML
+   Automatically generate a config from APIML.
 
  USAGE
  -----
@@ -135,8 +135,8 @@ exports[`config auto-init help should display help 1`] = `
   \\"success\\": true,
   \\"exitCode\\": 0,
   \\"message\\": \\"The help was constructed for command: auto-init.\\",
-  \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Automatically generate a config from APIML\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n   --user-config | --uc (boolean)\\\\n\\\\n      Save config in the user layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --global-config | --gc (boolean)\\\\n\\\\n      Save config in the global layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --dry-run | --dr | --dry (boolean)\\\\n\\\\n      Display the outcome of the initialization without saving\\\\n\\\\n   --edit | -e (boolean)\\\\n\\\\n      Open in editor after initializing the configuration\\\\n\\\\n   --overwrite | --ow (boolean)\\\\n\\\\n      Replaces an existing configuration with a new configuration\\\\n\\\\n      Default value: false\\\\n\\\\n   --for-sure | -f (boolean)\\\\n\\\\n      Confirms the overwrite option\\\\n\\\\n      Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --editor | --ed (string)\\\\n\\\\n      Editor that overrides the default editor for this file type. Set the option to\\\\n      the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n      notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of API Mediation Layer on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --token-type | --tt (string)\\\\n\\\\n      The type of token to get and use for the API Mediation Layer. Omit this option\\\\n      to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n   --token-value | --tv (string)\\\\n\\\\n      The value of the token to pass to the API Mediation Layer.\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use to authenticate to the API Mediation\\\\n      Layer\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use to authenticate to the API\\\\n      Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\",
+  \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Automatically generate a config from APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n   --user-config | --uc (boolean)\\\\n\\\\n      Save config in the user layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --global-config | --gc (boolean)\\\\n\\\\n      Save config in the global layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --dry-run | --dr | --dry (boolean)\\\\n\\\\n      Display the outcome of the initialization without saving\\\\n\\\\n   --edit | -e (boolean)\\\\n\\\\n      Open in editor after initializing the configuration\\\\n\\\\n   --overwrite | --ow (boolean)\\\\n\\\\n      Replaces an existing configuration with a new configuration\\\\n\\\\n      Default value: false\\\\n\\\\n   --for-sure | -f (boolean)\\\\n\\\\n      Confirms the overwrite option\\\\n\\\\n      Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --editor | --ed (string)\\\\n\\\\n      Editor that overrides the default editor for this file type. Set the option to\\\\n      the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n      notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of API Mediation Layer on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --token-type | --tt (string)\\\\n\\\\n      The type of token to get and use for the API Mediation Layer. Omit this option\\\\n      to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n   --token-value | --tv (string)\\\\n\\\\n      The value of the token to pass to the API Mediation Layer.\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use to authenticate to the API Mediation\\\\n      Layer\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use to authenticate to the API\\\\n      Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\",
   \\"stderr\\": \\"\\",
-  \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Automatically generate a config from APIML\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n   --user-config | --uc (boolean)\\\\n\\\\n      Save config in the user layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --global-config | --gc (boolean)\\\\n\\\\n      Save config in the global layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --dry-run | --dr | --dry (boolean)\\\\n\\\\n      Display the outcome of the initialization without saving\\\\n\\\\n   --edit | -e (boolean)\\\\n\\\\n      Open in editor after initializing the configuration\\\\n\\\\n   --overwrite | --ow (boolean)\\\\n\\\\n      Replaces an existing configuration with a new configuration\\\\n\\\\n      Default value: false\\\\n\\\\n   --for-sure | -f (boolean)\\\\n\\\\n      Confirms the overwrite option\\\\n\\\\n      Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --editor | --ed (string)\\\\n\\\\n      Editor that overrides the default editor for this file type. Set the option to\\\\n      the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n      notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of API Mediation Layer on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --token-type | --tt (string)\\\\n\\\\n      The type of token to get and use for the API Mediation Layer. Omit this option\\\\n      to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n   --token-value | --tv (string)\\\\n\\\\n      The value of the token to pass to the API Mediation Layer.\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use to authenticate to the API Mediation\\\\n      Layer\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use to authenticate to the API\\\\n      Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\"
+  \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Automatically generate a config from APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n   --user-config | --uc (boolean)\\\\n\\\\n      Save config in the user layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --global-config | --gc (boolean)\\\\n\\\\n      Save config in the global layer\\\\n\\\\n      Default value: false\\\\n\\\\n   --dry-run | --dr | --dry (boolean)\\\\n\\\\n      Display the outcome of the initialization without saving\\\\n\\\\n   --edit | -e (boolean)\\\\n\\\\n      Open in editor after initializing the configuration\\\\n\\\\n   --overwrite | --ow (boolean)\\\\n\\\\n      Replaces an existing configuration with a new configuration\\\\n\\\\n      Default value: false\\\\n\\\\n   --for-sure | -f (boolean)\\\\n\\\\n      Confirms the overwrite option\\\\n\\\\n      Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --editor | --ed (string)\\\\n\\\\n      Editor that overrides the default editor for this file type. Set the option to\\\\n      the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n      notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of API Mediation Layer on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --token-type | --tt (string)\\\\n\\\\n      The type of token to get and use for the API Mediation Layer. Omit this option\\\\n      to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n   --token-value | --tv (string)\\\\n\\\\n      The value of the token to pass to the API Mediation Layer.\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use to authenticate to the API Mediation\\\\n      Layer\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use to authenticate to the API\\\\n      Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\"
 }"
 `;
diff --git a/.../cli/__tests__/daemon/__unit__/disable/__snapshots__/Disable.definition.unit.test.ts.snap b/.../cli/__tests__/daemon/__unit__/disable/__snapshots__/Disable.definition.unit.test.ts.snap
@@ -2,14 +2,15 @@
 
 exports[`daemon disable definition should not have changed 1`] = `
 Object {
-  "description": "Disables daemon-mode operation of the Zowe CLI.",
+  "description": "Disable daemon-mode operation of the Zowe CLI.",
   "examples": Array [
     Object {
       "description": "Disable daemon-mode",
       "options": "",
     },
   ],
   "name": "disable",
+  "summary": "Disable daemon-mode operation of the Zowe CLI",
   "type": "command",
 }
 `;
diff --git a/...es/cli/__tests__/daemon/__unit__/enable/__snapshots__/Enable.definition.unit.test.ts.snap b/...es/cli/__tests__/daemon/__unit__/enable/__snapshots__/Enable.definition.unit.test.ts.snap
@@ -2,14 +2,15 @@
 
 exports[`daemon enable definition should not have changed 1`] = `
 Object {
-  "description": "Enables daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.",
+  "description": "Enable daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.",
   "examples": Array [
     Object {
       "description": "Enable daemon-mode",
       "options": "",
     },
   ],
   "name": "enable",
+  "summary": "Enable daemon-mode operation of the Zowe CLI",
   "type": "command",
 }
 `;
diff --git a/.../cli/__tests__/daemon/__unit__/restart/__snapshots__/restart.definition.unit.test.ts.snap b/.../cli/__tests__/daemon/__unit__/restart/__snapshots__/restart.definition.unit.test.ts.snap
@@ -1,6 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-
 exports[`daemon restart definition should not have changed 1`] = `
 Object {
   "description": "Restart the Zowe CLI daemon.",
@@ -11,6 +10,7 @@ Object {
     },
   ],
   "name": "restart",
+  "summary": "Restart the Zowe CLI daemon",
   "type": "command",
 }
 `;
diff --git a/...s/cli/__tests__/help/__integration__/__snapshots__/ZoweHelpTests.integration.test.ts.snap b/...s/cli/__tests__/help/__integration__/__snapshots__/ZoweHelpTests.integration.test.ts.snap
@@ -28,8 +28,8 @@ exports[`Root level help tests top level help should contain support link 1`] =
    auth                          Connect to Zowe API ML authentication service
    config                        Manage JSON project and global configuration 
    daemon                        Daemon operations                            
-   plugins                       Install and manage plug-ins.                 
-   profiles                      Create and manage configuration profiles.    
+   plugins                       Install and manage plug-ins                  
+   profiles                      Create and manage configuration profiles     
                                  (deprecated)                                 
    provisioning | pv             Perform z/OSMF provisioning tasks            
    zos-console | console         Issue z/OS console commands and collect      

diff --git a/...ing/__integration__/delete/__snapshots__/cli.provisioning.delete.integration.test.ts.snap b/...ing/__integration__/delete/__snapshots__/cli.provisioning.delete.integration.test.ts.snap
@@ -17,7 +17,7 @@ exports[`provisioning delete should display the help 1`] = `
  COMMANDS
  --------
 
-   template | tem Provision a published software service template.
+   template | tem Provision a published software service template
 
  GLOBAL OPTIONS
  --------------
@@ -42,8 +42,8 @@ exports[`provisioning delete should display the help 1`] = `
   \\"success\\": true,
   \\"exitCode\\": 0,
   \\"message\\": \\"The help was constructed for command: delete.\\",
-  \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe provisioning delete <command>\\\\n\\\\n   Where <command> is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n   instance | i Deletes instance.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --help-examples (boolean)\\\\n\\\\n      Display examples for all the commands in a group\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\",
+  \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe provisioning delete <command>\\\\n\\\\n   Where <command> is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n   instance | i Deletes instance\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --help-examples (boolean)\\\\n\\\\n      Display examples for all the commands in a group\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\",
   \\"stderr\\": \\"\\",
-  \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe provisioning delete <command>\\\\n\\\\n   Where <command> is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n   instance | i Deletes instance.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --help-examples (boolean)\\\\n\\\\n      Display examples for all the commands in a group\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\"
+  \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe provisioning delete <command>\\\\n\\\\n   Where <command> is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n   instance | i Deletes instance\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --help-examples (boolean)\\\\n\\\\n      Display examples for all the commands in a group\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n\\"
 }"
 `;