@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/sync-back/SyncBack.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

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

/*
 * 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.
 */
const SyncBackDefinition = {
    name: "sync-back",
    description: "Schedule global sync-back or sync-back for a specific mapping",
    summary: "Schedule sync-back",
    type: "command",
    handler: __dirname + "/SyncBack.handler",
    positionals: [EBGOptions.EBGOptions.CONTEXT, EBGOptions.EBGOptions.MAPPING],
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    options: EBGSession.EBGSession.EBG_CONNECTION_OPTIONS,
    examples: [
        {
            description: "Schedule global sync-back using the default EBG profile",
            options: "",
        },
        {
            description: "Schedule sync-back for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile",
            options: "MY-CONTEXT MY-MAPPING",
        },
    ],
};

exports.SyncBackDefinition = SyncBackDefinition;