diff --git a/packages/cli/__tests__/zosfiles/__integration__/view/ds/__snapshots__/cli.files.view.ds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/view/ds/__snapshots__/cli.files.view.ds.integration.test.ts.snap index 6304f4264a..232f9ae71c 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/view/ds/__snapshots__/cli.files.view.ds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/view/ds/__snapshots__/cli.files.view.ds.integration.test.ts.snap @@ -52,9 +52,9 @@ exports[`View data set should display the help 1`] = ` --range | -R (string) - The range of records to return in either of SSS-EEE where SSS is the start and - EEE is the end of records or SSS,NNN where is is the start and NNN is the number - of records retrieved. + The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS + identifies the start record, EEE identifies the end record, and NNN identifies + the number of retrieved records. --response-timeout | --rto (number) @@ -180,8 +180,8 @@ exports[`View data set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a z/OS data set on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either of SSS-EEE where SSS is the start and\\\\n EEE is the end of records or SSS,NNN where is is the start and NNN is the number\\\\n of records retrieved.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\"\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.test.loadlib(main)\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.test.loadlib(main)\\\\\\" --binary\\\\n\\\\n - View only the first two lines of content for data set\\\\n member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 0,2\\\\n\\\\n - View only lines six through eight (zero-based) in the\\\\n contents of the data set member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 5-7\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a z/OS data set on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS\\\\n identifies the start record, EEE identifies the end record, and NNN identifies\\\\n the number of retrieved records.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\"\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.test.loadlib(main)\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.test.loadlib(main)\\\\\\" --binary\\\\n\\\\n - View only the first two lines of content for data set\\\\n member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 0,2\\\\n\\\\n - View only lines six through eight (zero-based) in the\\\\n contents of the data set member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 5-7\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a z/OS data set on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either of SSS-EEE where SSS is the start and\\\\n EEE is the end of records or SSS,NNN where is is the start and NNN is the number\\\\n of records retrieved.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\"\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.test.loadlib(main)\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.test.loadlib(main)\\\\\\" --binary\\\\n\\\\n - View only the first two lines of content for data set\\\\n member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 0,2\\\\n\\\\n - View only lines six through eight (zero-based) in the\\\\n contents of the data set member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 5-7\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a z/OS data set on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS\\\\n identifies the start record, EEE identifies the end record, and NNN identifies\\\\n the number of retrieved records.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\"\\\\n\\\\n - View the contents of the data set member\\\\n \\\\\\"ibmuser.test.loadlib(main)\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.test.loadlib(main)\\\\\\" --binary\\\\n\\\\n - View only the first two lines of content for data set\\\\n member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 0,2\\\\n\\\\n - View only lines six through eight (zero-based) in the\\\\n contents of the data set member \\\\\\"ibmuser.cntl(iefbr14)\\\\\\":\\\\n\\\\n $ zowe zos-files view data-set \\\\\\"ibmuser.cntl(iefbr14)\\\\\\" --range 5-7\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/view/uss/__snapshots__/cli.files.view.uss.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/view/uss/__snapshots__/cli.files.view.uss.integration.test.ts.snap index 7373b07323..4fa43e9af3 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/view/uss/__snapshots__/cli.files.view.uss.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/view/uss/__snapshots__/cli.files.view.uss.integration.test.ts.snap @@ -39,9 +39,9 @@ exports[`View USS file should display the help 1`] = ` --range | -R (string) - The range of records to return in either of SSS-EEE where SSS is the start and - EEE is the end of records or SSS,NNN where is is the start and NNN is the number - of records retrieved. + The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS + identifies the start record, EEE identifies the end record, and NNN identifies + the number of retrieved records. --response-timeout | --rto (number) @@ -156,8 +156,8 @@ exports[`View USS file should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: uss-file.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a Unix System Services (USS) file on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n file\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either of SSS-EEE where SSS is the start and\\\\n EEE is the end of records or SSS,NNN where is is the start and NNN is the number\\\\n of records retrieved.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\":\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n - View the contents of the USS file\\\\n \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" --binary\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a Unix System Services (USS) file on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n file\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS\\\\n identifies the start record, EEE identifies the end record, and NNN identifies\\\\n the number of retrieved records.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\":\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n - View the contents of the USS file\\\\n \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" --binary\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a Unix System Services (USS) file on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n file\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either of SSS-EEE where SSS is the start and\\\\n EEE is the end of records or SSS,NNN where is is the start and NNN is the number\\\\n of records retrieved.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\":\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n - View the contents of the USS file\\\\n \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" --binary\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n View content from a Unix System Services (USS) file on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files view uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n file\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to display.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the file content in binary mode (no EBCDIC to ASCII conversion).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --range | -R (string)\\\\n\\\\n The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS\\\\n identifies the start record, EEE identifies the end record, and NNN identifies\\\\n the number of retrieved records.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n 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.\\\\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 EXAMPLES\\\\n --------\\\\n\\\\n - View the contents of the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\":\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n - View the contents of the USS file\\\\n \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files view uss-file \\\\\\"/a/ibmuser/MyJavaClass.class\\\\\\" --binary\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__unit__/view/ds/__snapshots__/Dataset.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/view/ds/__snapshots__/Dataset.definition.unit.test.ts.snap index c654283950..5ae80f91b9 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/view/ds/__snapshots__/Dataset.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/view/ds/__snapshots__/Dataset.definition.unit.test.ts.snap @@ -45,7 +45,7 @@ Array [ "aliases": Array [ "R", ], - "description": "The range of records to return in either of SSS-EEE where SSS is the start and EEE is the end of records or SSS,NNN where is is the start and NNN is the number of records retrieved.", + "description": "The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.", "name": "range", "type": "string", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/view/uss/__snapshots__/USSFiles.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/view/uss/__snapshots__/USSFiles.definition.unit.test.ts.snap index f2bd7c80a2..c6d6fe11a7 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/view/uss/__snapshots__/USSFiles.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/view/uss/__snapshots__/USSFiles.definition.unit.test.ts.snap @@ -26,7 +26,7 @@ Array [ "aliases": Array [ "R", ], - "description": "The range of records to return in either of SSS-EEE where SSS is the start and EEE is the end of records or SSS,NNN where is is the start and NNN is the number of records retrieved.", + "description": "The range of records to return in either \`SSS-EEE\` or \`SSS,NNN\` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.", "name": "range", "type": "string", }, diff --git a/packages/cli/src/zosfiles/-strings-/en.ts b/packages/cli/src/zosfiles/-strings-/en.ts index 33460c084b..cfc919c79a 100644 --- a/packages/cli/src/zosfiles/-strings-/en.ts +++ b/packages/cli/src/zosfiles/-strings-/en.ts @@ -751,8 +751,8 @@ export default { " Conflicts with binary.", VOLUME: "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required " + "only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", - RANGE: "The range of records to return in either of SSS-EEE where SSS is the start and EEE is the end of records " + - "or SSS,NNN where is is the start and NNN is the number of records retrieved." + RANGE: "The range of records to return in either `SSS-EEE` or `SSS,NNN` format. SSS identifies the start record, EEE " + + "identifies the end record, and NNN identifies the number of retrieved records." } }, EDIT: {