/** * @license * Copyright 2019 Balena Ltd. * * 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. */ import { Command } from '@oclif/command'; import * as _ from 'lodash'; export function getOclifHelpLinePairs(): Array<[string, string]> { // Although it's tempting to have these oclif commands 'require'd in a // central place, it would impact on performance (CLI start time). An // improvement would probably be to automatically scan the actions-oclif // folder. const EnvAddCmd = require('../actions-oclif/env/add').default; const VersionCmd = require('../actions-oclif/version').default; return [EnvAddCmd, VersionCmd].map(getCmdUsageDescriptionLinePair); } function getCmdUsageDescriptionLinePair(cmd: typeof Command): [string, string] { const usage = (cmd.usage || '').toString().toLowerCase(); let description = ''; // note: [^] matches any characters (including line breaks), achieving the // same effect as the 's' regex flag which is only supported by Node 9+ const matches = /\s*([^]+?)\n[^]*/.exec(cmd.description || ''); if (matches && matches.length > 1) { description = _.lowerFirst(_.trimEnd(matches[1], '.')); } return [usage, description]; }