@plexus-interop/cli/src/commands/Option.ts

Plexus Interop CLI tools

/**
 * Copyright 2017-2020 Plexus Interop Deutsche Bank AG
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
export interface Option {
    shortName: string;
    longName: string;
    exampleValue?: string;
    description?: string;
    isFlag?: boolean;
    isRequired?: boolean;
    defaultValue?: any;
}

export function getFlags(o: Option): string {
    return !!o.isRequired ? `-${o.shortName}, --${o.longName} <${o.longName}>`
            : !!o.isFlag ? `-${o.shortName}, --${o.longName}` 
                : `-${o.shortName}, --${o.longName} [${o.longName}]`;
}