@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/options/BuildOptions.js

Endevor Bridge for Git plug-in for Zowe CLI

"use strict";
/*
 * Copyright (c) 2019 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.BuildOptions = void 0;
const api_1 = require("../../api");
/**
 * Here are all the options used by developer build.
 */
class BuildOptions {
}
exports.BuildOptions = BuildOptions;
BuildOptions.ENDEVOR_WORK_AREA_GROUP = "Endevor work area options";
BuildOptions.INVENTORY_MAX_LEN = 8;
BuildOptions.OPTION_WORK_DIR = {
    name: "work-dir", aliases: ["wd"],
    description: "The local working directory of your Git-Endevor mapping that you are building.",
    type: "string",
    defaultValue: "./"
};
BuildOptions.ENDEVOR_OPTION_WORK_AREA_ID = {
    name: "work-area-id", aliases: ["waid"],
    type: "string",
    description: "Endevor work area ID. Name-masking is not allowed.",
    group: BuildOptions.ENDEVOR_WORK_AREA_GROUP,
    conflictsWith: ["endevor-subsystem", "endevor-environment", "endevor-system"]
};
BuildOptions.ENDEVOR_OPTION_SUBSYSTEM = {
    name: "endevor-subsystem", aliases: ["endevorsub"],
    description: "The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.",
    type: "string",
    stringLengthRange: [1, BuildOptions.INVENTORY_MAX_LEN],
    group: BuildOptions.ENDEVOR_WORK_AREA_GROUP,
    implies: ["endevor-environment", "endevor-system"]
};
BuildOptions.ENDEVOR_OPTION_ENVIRONMENT = {
    name: "endevor-environment", aliases: ["endevorenv"],
    description: "The Endevor SCM environment where your build subsystem resides.",
    type: "string",
    stringLengthRange: [1, BuildOptions.INVENTORY_MAX_LEN],
    group: BuildOptions.ENDEVOR_WORK_AREA_GROUP,
    implies: ["endevor-subsystem", "endevor-system"]
};
BuildOptions.ENDEVOR_OPTION_SYSTEM = {
    name: "endevor-system", aliases: ["endevorsys"],
    description: "The Endevor SCM system where your build subsystem resides.",
    type: "string",
    stringLengthRange: [1, BuildOptions.INVENTORY_MAX_LEN],
    group: BuildOptions.ENDEVOR_WORK_AREA_GROUP,
    implies: ["endevor-subsystem", "endevor-environment"]
};
BuildOptions.OPTION_AUTOGEN = {
    name: "autogen-span", aliases: ["ags"],
    description: "Specifies the autogen action option to automatically generate using elements.\n" +
        "The allowed values which have the following meaning:\n" +
        "NONE - Generates all elements that use the component being acted upon.\n" +
        "ALL - Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.\n" +
        "SYSTEMS - Generates using elements that are found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component.\n" +
        "SUBSYSTEMS - Generates using elements from all Subsystems with the same-named System of the component specified.",
    type: "string",
    defaultValue: "NONE",
    allowableValues: {
        values: ["NONE", "ALL", "SYSTEMS", "SUBSYSTEMS"],
        caseSensitive: false
    }
};
BuildOptions.OPTION_SKELETON_JCL = {
    name: "skeleton-jcl", aliases: ["sjcl"],
    description: "The path of the file of skeleton JCL to submit endevor scl statements. Download it from: " +
        "https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-endevor-integrations-for-enterprise-devops/1-0/ca-endevor-bridge-for-git/set-up-and-run-the-ca-endevor-bridge-for-git/configuration-for-build-using-zowe-cli.html",
    type: "string",
    required: true
};
BuildOptions.OPTION_LISTING_DIR = {
    name: "listing-dir",
    description: "Specify the directory where you would like to have your build outputs downloaded",
    type: "string",
    defaultValue: api_1.EBGConstants.getEndevorListingsDir()
};
BuildOptions.OPTION_LISTING_RC = {
    name: "listing-rc",
    description: "All the elements that have a generate result equal to or greater than \"listing-rc\" will have their build outputs downloaded into \"listing-dir\"",
    type: "number",
    defaultValue: 4
};
BuildOptions.OPTION_FORCE_CLEAN_UP = {
    name: "force-cleanup", aliases: ["fc"],
    description: "Starts the build process after cleaning the build subsystem.",
    type: "boolean",
    defaultValue: false
};
//# sourceMappingURL=BuildOptions.js.map