Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace ZOWE_EDITOR with ZOWE_OPT_EDITOR for consistency #1974

Merged
merged 8 commits into from
Nov 29, 2023
+105 −80
Merged

Replace ZOWE_EDITOR with ZOWE_OPT_EDITOR for consistency #1974

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
498a02b
Replace ZOWE_EDITOR with ZOWE_OPT_EDITOR for consistency
t1m0thyj Nov 27, 2023
68ee82c
Update test snapshots
t1m0thyj Nov 27, 2023
c46c34f
Merge branch 'next' into feat/enhance-editor-option
t1m0thyj Nov 28, 2023
164d916
Fix lint errors and update changelogs for consistency
t1m0thyj Nov 28, 2023
69d5658
Merge branch 'next' into feat/enhance-editor-option
t1m0thyj Nov 28, 2023
27a924c
More changelog updates
t1m0thyj Nov 28, 2023
e95744e
Merge branch 'next' into feat/enhance-editor-option
t1m0thyj Nov 28, 2023
ba76246
Fix changelog for CLI and Imperative
t1m0thyj Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion __tests__/__packages__/cli-test-utils/CHANGELOG.md
View file
Open in desktop
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
5 changes: 3 additions & 2 deletions packages/cli/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ All notable changes to the Zowe CLI package will be documented in this file.

## `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)
- 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.202311141517`

Expand All @@ -13,7 +14,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
Open in desktop
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
Loading