@zowe/imperative
Version:
framework for building configurable CLIs
119 lines • 4.42 kB
JavaScript
;
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.initDefinition = void 0;
const path_1 = require("path");
const utilities_1 = require("../../../../../utilities");
/**
* Definition of the init command.
* @type {ICommandDefinition}
*/
exports.initDefinition = {
name: "init",
type: "command",
handler: (0, path_1.join)(__dirname, "init.handler"),
summary: "Init config files",
description: `Initialize config files. Defaults to initializing "${utilities_1.ImperativeConfig.instance.rootCommandName}.config.json" in the current ` +
`working directory unless otherwise specified.\n\nUse "--user-config" to init ` +
`"${utilities_1.ImperativeConfig.instance.rootCommandName}.config.user.json". Use "--global-config" to initialize the configuration files in your home ` +
`"~/.zowe" directory.\n\nUse "--no-prompt" to skip prompting for values in a CI environment.`,
options: [
{
name: "global-config",
description: "Target the global config files.",
aliases: ["gc"],
type: "boolean",
defaultValue: false
},
{
name: "user-config",
description: "Target the user config files.",
aliases: ["uc"],
type: "boolean",
defaultValue: false
},
{
name: "prompt",
description: "Prompt for missing values in the base profile. Useful for disabling prompting in CI environments.",
type: "boolean",
defaultValue: true
},
{
name: "overwrite",
description: "Replace existing config files instead of merging the new changes.",
aliases: ["ow"],
type: "boolean",
conflictsWith: ["dry-run"],
implies: ["for-sure"]
},
{
name: "for-sure",
aliases: ["fs"],
description: "Confirms the overwrite option.",
type: "boolean",
defaultValue: false
},
{
name: "dry-run",
description: "Display the outcome of the initialization without saving it.",
aliases: ["dr", "dry"],
type: "boolean",
conflictsWith: ["edit", "overwrite", "prompt"]
},
{
name: "edit",
aliases: ["e"],
description: "Open in editor after initializing the configuration.",
type: "boolean",
conflictsWith: ["dry-run"]
},
{
name: "editor",
description: `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".`,
aliases: ["ed"],
type: "string",
implies: ["edit"]
}
],
examples: [
{
description: `Initialize configuration files in your home "~/.zowe" directory`,
options: "--global-config"
},
{
description: `Do a dry run of initializing configuration files in your home "~/.zowe" directory`,
options: "--global-config --dry-run"
},
{
description: "Initialize the user config files",
options: "--user-config"
},
{
description: "Initialize the user config files and do not prompt for secure values",
options: "--user-config --prompt false"
},
{
description: "Do a dry run of initializing the user config files and do not prompt for secure values",
options: "--user-config --prompt false --dry-run"
},
{
description: "Overwrite any existing global config files",
options: "--global-config --overwrite --for-sure"
},
{
description: "Overwrite any existing user config files",
options: "--user-config --overwrite --for-sure"
}
]
};
//# sourceMappingURL=init.definition.js.map