Skip to content

Commit

Permalink
Merge pull request #1974 from zowe/feat/enhance-editor-option
Browse files Browse the repository at this point in the history 
Replace ZOWE_EDITOR with ZOWE_OPT_EDITOR for consistency
  • Loading branch information
@t1m0thyj
t1m0thyj authored Nov 29, 2023
2 parents 1a996dc + ba76246 commit e117919
Show file tree
Hide file tree
Showing 33 changed files with 105 additions and 80 deletions.
2 changes: 1 addition & 1 deletion __tests__/__packages__/cli-test-utils/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All notable changes to the Zowe CLI test utils package will be documented in thi

## `8.0.0-next.202311132045`

- Breaking: First major version bump for V3
- Major: First major version bump for V3

## `7.18.11`

Expand Down
8 changes: 6 additions & 2 deletions packages/cli/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@

All notable changes to the Zowe CLI package will be documented in this file.

## Recent Changes

- LTS Breaking: Replaced the `ZOWE_EDITOR` environment variable with `ZOWE_OPT_EDITOR` and `--editor` option on commands [#1867](https://github.com/zowe/zowe-cli/issues/1867)

## `8.0.0-next.202311282012`

- Breaking: Moved `getDataSet` from the `zosfiles` command group to the `zosfiles` SDK as `ZosFilesUtils.getDataSetFromName` [#1696](https://github.com/zowe/zowe-cli/issues/1696)
- LTS Breaking: Moved `getDataSet` from the `zosfiles` command group to the `zosfiles` SDK as `ZosFilesUtils.getDataSetFromName` [#1696](https://github.com/zowe/zowe-cli/issues/1696)

## `8.0.0-next.202311141517`

Expand All @@ -13,7 +17,7 @@ All notable changes to the Zowe CLI package will be documented in this file.

## `8.0.0-next.202311132045`

- Breaking: First major version bump for V3
- Major: First major version bump for V3

## `7.18.10`

Expand Down
13 changes: 11 additions & 2 deletions ...fig/auto-init/__integration__/__snapshots__/cli.config.auto-init.integration.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,15 @@ exports[`config auto-init help should display help 1`] = `
Default value: false
OPTIONS
-------
--editor | --ed (string)
Editor that overrides the default editor for this file type. Set the option to
the editor's executable file location or the program's name: ie \\"--editor
notepad\\"
APIML CONNECTION OPTIONS
------------------------
Expand Down Expand Up @@ -126,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 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 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\\"
}"
`;
Loading

0 comments on commit e117919

Please sign in to comment.