@broadcom/endevor-for-zowe-cli/lib/cli/WorkspaceOptions.js

Endevor Plug-in for Zowe CLI

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.WorkspaceOptions = void 0;
const api_1 = require("../api");
class WorkspaceOptions {
}
exports.WorkspaceOptions = WorkspaceOptions;
WorkspaceOptions.posWorkspaceFile = {
    name: api_1.args["workspace-file"],
    description: "An Endevor workspace file (full or relative path).",
    type: "string"
};
WorkspaceOptions.posWorkspaceDir = {
    name: api_1.args["workspace-dir"],
    description: "The Endevor workspace directory, if different from current working directory.",
    type: "string"
};
WorkspaceOptions.optWorkspaceDir = {
    name: api_1.args["workspace-dir"],
    aliases: ["wsp"],
    description: "The Endevor workspace directory, if different from current working directory.",
    defaultValue: ".",
    required: false,
    type: "string",
    group: "workspace options"
};
WorkspaceOptions.optDryRun = {
    name: api_1.args["dry-run"],
    aliases: ["dr"],
    description: "List all actions the synchronization would perform, without executing them.",
    type: "boolean",
    group: "workspace options"
};
WorkspaceOptions.optReset = {
    name: api_1.args["reset"],
    aliases: ["rst"],
    description: "Revert any local changes, resetting the local workspace to match the current state of the remote Endevor inventory.",
    type: "boolean",
    group: "workspace options"
};
WorkspaceOptions.optLimit = {
    name: api_1.args["limit"],
    aliases: ["lim"],
    description: "If the synchronization would need to perform more than 'limit' Endevor actions, do not perform the actions now, only report them. 0 means no limit.",
    type: "number",
    defaultValue: 0,
    group: "workspace options"
};
WorkspaceOptions.optNoUpdate = {
    name: api_1.args["one-way"],
    aliases: [],
    description: "Do not update Endevor elements with local changes, only retrieve remote changes from Endevor and resolve any conflicts.",
    type: "boolean",
    group: "workspace options"
};
WorkspaceOptions.optForce = {
    name: api_1.args["force"],
    aliases: ["f"],
    description: "Force unsynchronization of local workspace regardless of any local changes not yet saved into Endevor.",
    type: "boolean",
    group: "workspace options"
};
WorkspaceOptions.optAllowDeletes = {
    name: api_1.args["allow-deletes"],
    aliases: ["del"],
    description: "Allow workspace synchronization to delete unchanged Endevor elements when it detects the corresponding local files have been deleted. Default is off to maintain backward compatibility.",
    type: "boolean",
    group: "workspace options"
};
WorkspaceOptions.optElement = {
    name: api_1.args.element,
    aliases: ["ele", "elem"],
    type: "string",
    description: "Name filter to synchronize only specific Endevor element(s).",
    defaultValue: "*",
    stringLengthRange: [1, api_1.EndevorConstants.ELEM_MAX_LEN],
    group: "workspace options"
};
WorkspaceOptions.optFileExtension = {
    name: api_1.args["file-extension"],
    aliases: ["ext"],
    description: `The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      none: File name is equal to element name, no extension is added.

      file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.

      type-name: The type name is used as the file extension.

      mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.`,
    type: "string",
    allowableValues: {
        values: ["none", "file-ext", "type-name", "mixed"],
        caseSensitive: false
    },
    defaultValue: "mixed",
    group: "workspace options"
};
WorkspaceOptions.optActOVESIGN = {
    name: api_1.args["override-signout"],
    aliases: ["os"],
    description: "Specify if you want to override the Signout of any Endevor elements affected by this action.",
    type: "boolean",
    group: "options"
};
WorkspaceOptions.optActSIGNOUT = {
    name: api_1.args.signout,
    description: "Specify if you want to perform the action with signing out any retrieved elements.",
    type: "boolean",
    group: "options"
};
WorkspaceOptions.optMergeEnvironment = {
    name: api_1.args["merge-environment"],
    aliases: ["menv"],
    type: "string",
    description: "Merge elements from this environment to the target environment (specified by 'environment'). Defaults to the same environment as the target.",
    stringLengthRange: [1, api_1.EndevorConstants.ELEM_MAX_LEN],
    group: "merge-location definition options"
};
WorkspaceOptions.optMergeStageNumber = {
    name: api_1.args["merge-stage-number"],
    aliases: ["msn"],
    type: "string",
    description: "Merge elements from this stage number into the target stage number (specified by 'stage-number'). Defaults to the same stage number as the target.",
    stringLengthRange: [1, api_1.EndevorConstants.ELEM_MAX_LEN],
    group: "merge-location definition options"
};
WorkspaceOptions.optMergeSystem = {
    name: api_1.args["merge-system"],
    aliases: ["msys"],
    type: "string",
    description: "Merge elements from this system into the target system (specified by 'system'). Defaults to the same system as the target.",
    stringLengthRange: [1, api_1.EndevorConstants.ELEM_MAX_LEN],
    group: "merge-location definition options"
};
WorkspaceOptions.optMergeSubsystem = {
    name: api_1.args["merge-subsystem"],
    aliases: ["msub"],
    type: "string",
    description: "Merge elements from this subsystem into the target subsystem (specified by 'subsystem'). Defaults to the same subsystem as the target.",
    stringLengthRange: [1, api_1.EndevorConstants.ELEM_MAX_LEN],
    group: "merge-location definition options"
};
WorkspaceOptions.optMergeOOS = {
    name: api_1.args["merge-out-of-sync"],
    aliases: ["moos"],
    type: "boolean",
    description: "Merge out-of-sync elements at the target location with their next version in the map, and attempt to resolve the out-of-sync during the next synchronization with Endevor.",
    conflictsWith: ["merge-environment", "merge-stage-number", "merge-system", "merge-subsystem"],
    group: "merge-location definition options"
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiV29ya3NwYWNlT3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jbGkvV29ya3NwYWNlT3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUF3QkEsZ0NBQWdEO0FBVWhELE1BQWEsZ0JBQWdCOztBQUE3Qiw0Q0EyUkM7QUFuUmUsaUNBQWdCLEdBQWlDO0lBQzdELElBQUksRUFBRSxVQUFJLENBQUMsZ0JBQWdCLENBQUM7SUFDNUIsV0FBVyxFQUFFLG9EQUFvRDtJQUNqRSxJQUFJLEVBQUUsUUFBUTtDQUNmLENBQUM7QUFTWSxnQ0FBZSxHQUFpQztJQUM1RCxJQUFJLEVBQUUsVUFBSSxDQUFDLGVBQWUsQ0FBQztJQUMzQixXQUFXLEVBQUUsK0VBQStFO0lBQzVGLElBQUksRUFBRSxRQUFRO0NBQ2YsQ0FBQztBQVNZLGdDQUFlLEdBQTZCO0lBQ3hELElBQUksRUFBRSxVQUFJLENBQUMsZUFBZSxDQUFDO0lBQzNCLE9BQU8sRUFBRSxDQUFDLEtBQUssQ0FBQztJQUNoQixXQUFXLEVBQUUsK0VBQStFO0lBQzVGLFlBQVksRUFBRSxHQUFHO0lBQ2pCLFFBQVEsRUFBRSxLQUFLO0lBQ2YsSUFBSSxFQUFFLFFBQVE7SUFDZCxLQUFLLEVBQUUsbUJBQW1CO0NBQzNCLENBQUM7QUFTWSwwQkFBUyxHQUE2QjtJQUNsRCxJQUFJLEVBQUUsVUFBSSxDQUFDLFNBQVMsQ0FBQztJQUNyQixPQUFPLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDZixXQUFXLEVBQUUsNkVBQTZFO0lBQzFGLElBQUksRUFBRSxTQUFTO0lBQ2YsS0FBSyxFQUFFLG1CQUFtQjtDQUMzQixDQUFDO0FBU1kseUJBQVEsR0FBNkI7SUFDakQsSUFBSSxFQUFFLFVBQUksQ0FBQyxPQUFPLENBQUM7SUFDbkIsT0FBTyxFQUFFLENBQUMsS0FBSyxDQUFDO0lBQ2hCLFdBQVcsRUFDVCxxSEFBcUg7SUFDdkgsSUFBSSxFQUFFLFNBQVM7SUFDZixLQUFLLEVBQUUsbUJBQW1CO0NBQzNCLENBQUM7QUFTWSx5QkFBUSxHQUE2QjtJQUNqRCxJQUFJLEVBQUUsVUFBSSxDQUFDLE9BQU8sQ0FBQztJQUNuQixPQUFPLEVBQUUsQ0FBQyxLQUFLLENBQUM7SUFDaEIsV0FBVyxFQUNULHFKQUFxSjtJQUN2SixJQUFJLEVBQUUsUUFBUTtJQUNkLFlBQVksRUFBRSxDQUFDO0lBQ2YsS0FBSyxFQUFFLG1CQUFtQjtDQUMzQixDQUFDO0FBVVksNEJBQVcsR0FBNkI7SUFDcEQsSUFBSSxFQUFFLFVBQUksQ0FBQyxTQUFTLENBQUM7SUFDckIsT0FBTyxFQUFFLEVBQUU7SUFDWCxXQUFXLEVBQ1QseUhBQXlIO0lBQzNILElBQUksRUFBRSxTQUFTO0lBQ2YsS0FBSyxFQUFFLG1CQUFtQjtDQUMzQixDQUFDO0FBVVkseUJBQVEsR0FBNkI7SUFDakQsSUFBSSxFQUFFLFVBQUksQ0FBQyxPQUFPLENBQUM7SUFDbkIsT0FBTyxFQUFFLENBQUMsR0FBRyxDQUFDO0lBQ2QsV0FBVyxFQUNULHdHQUF3RztJQUMxRyxJQUFJLEVBQUUsU0FBUztJQUNmLEtBQUssRUFBRSxtQkFBbUI7Q0FDM0IsQ0FBQztBQVVZLGdDQUFlLEdBQTZCO0lBQ3hELElBQUksRUFBRSxVQUFJLENBQUMsZUFBZSxDQUFDO0lBQzNCLE9BQU8sRUFBRSxDQUFDLEtBQUssQ0FBQztJQUNoQixXQUFXLEVBQ1QsMExBQTBMO0lBQzVMLElBQUksRUFBRSxTQUFTO0lBQ2YsS0FBSyxFQUFFLG1CQUFtQjtDQUMzQixDQUFDO0FBTVksMkJBQVUsR0FBNkI7SUFDbkQsSUFBSSxFQUFFLFVBQUksQ0FBQyxPQUFPO0lBQ2xCLE9BQU8sRUFBRSxDQUFDLEtBQUssRUFBRSxNQUFNLENBQUM7SUFDeEIsSUFBSSxFQUFFLFFBQVE7SUFDZCxXQUFXLEVBQUUsOERBQThEO0lBQzNFLFlBQVksRUFBRSxHQUFHO0lBQ2pCLGlCQUFpQixFQUFFLENBQUMsQ0FBQyxFQUFFLHNCQUFnQixDQUFDLFlBQVksQ0FBQztJQUNyRCxLQUFLLEVBQUUsbUJBQW1CO0NBQzNCLENBQUM7QUFVWSxpQ0FBZ0IsR0FBNkI7SUFDekQsSUFBSSxFQUFFLFVBQUksQ0FBQyxnQkFBZ0IsQ0FBQztJQUM1QixPQUFPLEVBQUUsQ0FBQyxLQUFLLENBQUM7SUFDaEIsV0FBVyxFQUFFOzs7Ozs7OzttSEFRa0c7SUFDL0csSUFBSSxFQUFFLFFBQVE7SUFDZCxlQUFlLEVBQUU7UUFDZixNQUFNLEVBQUUsQ0FBQyxNQUFNLEVBQUUsVUFBVSxFQUFFLFdBQVcsRUFBRSxPQUFPLENBQUM7UUFDbEQsYUFBYSxFQUFFLEtBQUs7S0FDckI7SUFDRCxZQUFZLEVBQUUsT0FBTztJQUNyQixLQUFLLEVBQUUsbUJBQW1CO0NBQzNCLENBQUM7QUFXWSw4QkFBYSxHQUE2QjtJQUN0RCxJQUFJLEVBQUUsVUFBSSxDQUFDLGtCQUFrQixDQUFDO0lBQzlCLE9BQU8sRUFBRSxDQUFDLElBQUksQ0FBQztJQUNmLFdBQVcsRUFBRSw4RkFBOEY7SUFDM0csSUFBSSxFQUFFLFNBQVM7SUFDZixLQUFLLEVBQUUsU0FBUztDQUNqQixDQUFDO0FBV1ksOEJBQWEsR0FBNkI7SUFDdEQsSUFBSSxFQUFFLFVBQUksQ0FBQyxPQUFPO0lBQ2xCLFdBQVcsRUFBRSxvRkFBb0Y7SUFDakcsSUFBSSxFQUFFLFNBQVM7SUFDZixLQUFLLEVBQUUsU0FBUztDQUNqQixDQUFDO0FBS1ksb0NBQW1CLEdBQTZCO0lBQzVELElBQUksRUFBRSxVQUFJLENBQUMsbUJBQW1CLENBQUM7SUFDL0IsT0FBTyxFQUFFLENBQUMsTUFBTSxDQUFDO0lBQ2pCLElBQUksRUFBRSxRQUFRO0lBQ2QsV0FBVyxFQUNULDhJQUE4STtJQUNoSixpQkFBaUIsRUFBRSxDQUFDLENBQUMsRUFBRSxzQkFBZ0IsQ0FBQyxZQUFZLENBQUM7SUFDckQsS0FBSyxFQUFFLG1DQUFtQztDQUMzQyxDQUFDO0FBS1ksb0NBQW1CLEdBQTZCO0lBQzVELElBQUksRUFBRSxVQUFJLENBQUMsb0JBQW9CLENBQUM7SUFDaEMsT0FBTyxFQUFFLENBQUMsS0FBSyxDQUFDO0lBQ2hCLElBQUksRUFBRSxRQUFRO0lBQ2QsV0FBVyxFQUNULG9KQUFvSjtJQUN0SixpQkFBaUIsRUFBRSxDQUFDLENBQUMsRUFBRSxzQkFBZ0IsQ0FBQyxZQUFZLENBQUM7SUFDckQsS0FBSyxFQUFFLG1DQUFtQztDQUMzQyxDQUFDO0FBS1ksK0JBQWMsR0FBNkI7SUFDdkQsSUFBSSxFQUFFLFVBQUksQ0FBQyxjQUFjLENBQUM7SUFDMUIsT0FBTyxFQUFFLENBQUMsTUFBTSxDQUFDO0lBQ2pCLElBQUksRUFBRSxRQUFRO0lBQ2QsV0FBVyxFQUNULDRIQUE0SDtJQUM5SCxpQkFBaUIsRUFBRSxDQUFDLENBQUMsRUFBRSxzQkFBZ0IsQ0FBQyxZQUFZLENBQUM7SUFDckQsS0FBSyxFQUFFLG1DQUFtQztDQUMzQyxDQUFDO0FBS1ksa0NBQWlCLEdBQTZCO0lBQzFELElBQUksRUFBRSxVQUFJLENBQUMsaUJBQWlCLENBQUM7SUFDN0IsT0FBTyxFQUFFLENBQUMsTUFBTSxDQUFDO0lBQ2pCLElBQUksRUFBRSxRQUFRO0lBQ2QsV0FBVyxFQUNULHdJQUF3STtJQUMxSSxpQkFBaUIsRUFBRSxDQUFDLENBQUMsRUFBRSxzQkFBZ0IsQ0FBQyxZQUFZLENBQUM7SUFDckQsS0FBSyxFQUFFLG1DQUFtQztDQUMzQyxDQUFDO0FBS1ksNEJBQVcsR0FBNkI7SUFDcEQsSUFBSSxFQUFFLFVBQUksQ0FBQyxtQkFBbUIsQ0FBQztJQUMvQixPQUFPLEVBQUUsQ0FBQyxNQUFNLENBQUM7SUFDakIsSUFBSSxFQUFFLFNBQVM7SUFDZixXQUFXLEVBQ1QsNEtBQTRLO0lBQzlLLGFBQWEsRUFBRSxDQUFDLG1CQUFtQixFQUFFLG9CQUFvQixFQUFFLGNBQWMsRUFBRSxpQkFBaUIsQ0FBQztJQUM3RixLQUFLLEVBQUUsbUNBQW1DO0NBQzNDLENBQUMifQ==