zowe config convert prompt option description and examples are unclear #2609
Description
Describe the bug
The --prompt option has no effect if the --delete flag is not included as part of the command. I.e., the only thing Zowe CLI prompts for is whether or not to delete the v1 profiles.
The description for the prompt option does not make it clear what we are prompting for.
Because it does not include the --delete flag, the first example (with only the --no-prompt option), is no different than running with the --prompt option.
Expected and actual results
Suggestions:
- Clarify, in the
promptdescription, that this option, when true, will prompt the user before deleting v1 profiles and, when false, will delete the v1 profiles without prompting. - Either change the first option to include the
--deleteand--no-promptflags and update the description to reflect that this example will delete the v1 profiles after conversion without prompting the user.
Describe your environment
- Zowe CLI version installed (run command
zowe --version): 8.27.0
Additional context
From packages\imperative\src\imperative\src\config\cmd\convert-profiles\convert-profiles.definition.ts:
export const convertProfilesDefinition: ICommandDefinition = {
name: "convert-profiles",
aliases: ["convert"],
type: "command",
handler: join(__dirname, "convert-profiles.handler"),
summary: "Convert V1 profiles to a current Zowe client configuration",
description: `Convert v1 profiles to a global ${ImperativeConfig.instance.rootCommandName}.config.json file.`,
options: [{
name: "prompt",
description: "Prompt for confirmation. Use --no-prompt to disable prompting.",
type: "boolean",
defaultValue: true
}, {
name: "delete",
description: "Delete the existing profiles on disk and any securely stored secrets.",
type: "boolean"
}],
examples: [{
description: "Convert V1 profiles to a new Zowe client configuration without prompting",
options: "--no-prompt"
}, {
description: "Convert V1 profiles to a new Zowe client configuration and delete the old V1 profiles",
options: "--delete"
}]
};