@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/list/list-generate-settings/ListGenerateSettings.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var GenerateOptions = require('../../../options/GenerateOptions.js');

/*
 * Copyright (c) 2026 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.
 *
 */
const ListGenerateSettingsDefinition = {
    name: "generate-settings",
    aliases: ["generate", "gen"],
    type: "command",
    handler: __dirname + "/ListGenerateSettings.handler",
    description: "List the global generate settings or the generate settings used by your mapping.",
    summary: "List generate settings",
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    positionals: [GenerateOptions.GenerateOptions.CONTEXT, GenerateOptions.GenerateOptions.MAPPING],
    examples: [
        {
            description: "List the global generate settings using the default EBG profile",
            options: "",
        },
        {
            description: "List the generate settings a mapping using the default EBG profile",
            options: "MY-CONTEXT MY-MAPPING",
        },
        {
            description: "List the global generate settings without an EBG profile",
            options: "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890",
        },
    ],
};

exports.ListGenerateSettingsDefinition = ListGenerateSettingsDefinition;