Add support for primary/secondary oclif commands

Change-type: minor
Signed-off-by: Scott Lowe <scott@balena.io>

lib/actions-oclif/devices/supported.ts

@@ -14,10 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Command, flags } from '@oclif/command';
+import { flags } from '@oclif/command';
 import * as SDK from 'balena-sdk';
 import { stripIndent } from 'common-tags';
 import * as _ from 'lodash';
+import Command from '../../command';
 
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, getVisuals } from '../../utils/lazy';

lib/actions-oclif/env/add.ts

@@ -15,10 +15,11 @@
  * limitations under the License.
  */
 
-import { Command, flags } from '@oclif/command';
+import { flags } from '@oclif/command';
 import * as BalenaSdk from 'balena-sdk';
 import { stripIndent } from 'common-tags';
 import * as _ from 'lodash';
+import Command from '../../command';
 
 import { ExpectedError } from '../../errors';
 import * as cf from '../../utils/common-flags';

lib/actions-oclif/env/rename.ts

@@ -14,8 +14,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Command, flags } from '@oclif/command';
+import { flags } from '@oclif/command';
 import { stripIndent } from 'common-tags';
+import Command from '../../command';
 
 import * as cf from '../../utils/common-flags';
 import * as ec from '../../utils/env-common';

lib/actions-oclif/env/rm.ts

@@ -15,8 +15,9 @@
  * limitations under the License.
  */
 
-import { Command, flags } from '@oclif/command';
+import { flags } from '@oclif/command';
 import { stripIndent } from 'common-tags';
+import Command from '../../command';
 
 import * as ec from '../../utils/env-common';
 import { getBalenaSdk } from '../../utils/lazy';

lib/actions-oclif/envs.ts

@@ -14,10 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Command, flags } from '@oclif/command';
+import { flags } from '@oclif/command';
 import * as SDK from 'balena-sdk';
 import { stripIndent } from 'common-tags';
 import * as _ from 'lodash';
+import Command from '../command';
 
 import { ExpectedError } from '../errors';
 import * as cf from '../utils/common-flags';

lib/actions-oclif/os/configure.ts

@@ -15,12 +15,13 @@
  * limitations under the License.
  */
 
-import { Command, flags } from '@oclif/command';
+import { flags } from '@oclif/command';
 import BalenaSdk = require('balena-sdk');
 import Bluebird = require('bluebird');
 import { stripIndent } from 'common-tags';
 import * as _ from 'lodash';
 import * as path from 'path';
+import Command from '../../command';
 
 import { ExpectedError } from '../../errors';
 import * as cf from '../../utils/common-flags';

lib/actions-oclif/version.ts

@@ -15,8 +15,9 @@
  * limitations under the License.
  */
 
-import { Command, flags } from '@oclif/command';
+import { flags } from '@oclif/command';
 import { stripIndent } from 'common-tags';
+import Command from '../command';
 
 interface FlagsDef {
 	all?: boolean;

lib/actions/help.coffee

@@ -77,31 +77,35 @@ general = (params, options, done) ->
 	commands = _.reject capitano.state.commands, (command) ->
 		return command.hidden or command.isWildcard()
 
-	groupedCommands = _.groupBy commands, (command) ->
+	capitanoCommands = _.groupBy commands, (command) ->
 		if command.primary
 			return 'primary'
 		return 'secondary'
 
-	print parse(groupedCommands.primary).sort(getManualSortCompareFunction(
+	getOclifHelpLinePairs()
-		manuallySortedPrimaryCommands,
+	.then (oclifHelpLinePairs) ->
-		([signature, description], manualItem) ->
-			signature == manualItem or signature.startsWith("#{manualItem} ")
-	))
 
-	if options.verbose
+		primaryHelpLinePairs =
-		console.log('\nAdditional commands:\n')
+		parse(capitanoCommands.primary).concat(oclifHelpLinePairs.primary).sort(getManualSortCompareFunction(
-		secondaryCommandPromise = getOclifHelpLinePairs()
+			manuallySortedPrimaryCommands,
-		.then (oclifHelpLinePairs) ->
+			([signature, description], manualItem) ->
-			print parse(groupedCommands.secondary).concat(oclifHelpLinePairs).sort()
+				signature == manualItem or signature.startsWith("#{manualItem} ")
-	else
+		))
-		console.log('\nRun `balena help --verbose` to list additional commands')
+
-		secondaryCommandPromise = Promise.resolve()
+		secondaryHelpLinePairs = parse(capitanoCommands.secondary).concat(oclifHelpLinePairs.secondary).sort()
+
+		print primaryHelpLinePairs
+
+		if options.verbose
+			console.log('\nAdditional commands:\n')
+			print secondaryHelpLinePairs
+		else
+			console.log('\nRun `balena help --verbose` to list additional commands')
 
-	secondaryCommandPromise
-	.then ->
 		if not _.isEmpty(capitano.state.globalOptions)
 			console.log('\nGlobal Options:\n')
 			print parse(capitano.state.globalOptions).sort()
+
 		done()
 	.catch(done)
 

lib/actions/help_ts.ts

@@ -15,32 +15,38 @@
  * limitations under the License.
  */
 
-import { Command } from '@oclif/command';
-import * as Bluebird from 'bluebird';
 import * as _ from 'lodash';
 import * as path from 'path';
+import Command from '../command';
 
 import { capitanoizeOclifUsage } from '../utils/oclif-utils';
 
-export async function getOclifHelpLinePairs(): Promise<
+export async function getOclifHelpLinePairs() {
-	Array<[string, string]>
-> {
 	const { convertedCommands } = await import('../preparser');
-	const cmdClasses: Array<Promise<typeof Command>> = [];
+	const primary: Array<[string, string]> = [];
+	const secondary: Array<[string, string]> = [];
+
 	for (const convertedCmd of convertedCommands) {
 		const [topic, cmd] = convertedCmd.split(':');
 		const pathComponents = ['..', 'actions-oclif', topic];
 		if (cmd) {
 			pathComponents.push(cmd);
 		}
-		// note that `import(path)` returns a promise
+
-		cmdClasses.push(import(path.join(...pathComponents)));
+		const cmdModule = await import(path.join(...pathComponents));
+		const command: typeof Command = cmdModule.default;
+
+		if (command.primary) {
+			primary.push(getCmdUsageDescriptionLinePair(command));
+		} else {
+			secondary.push(getCmdUsageDescriptionLinePair(command));
+		}
 	}
-	return Bluebird.map(cmdClasses, getCmdUsageDescriptionLinePair);
+
+	return { primary, secondary };
 }
 
-function getCmdUsageDescriptionLinePair(cmdModule: any): [string, string] {
+function getCmdUsageDescriptionLinePair(cmd: typeof Command): [string, string] {
-	const cmd: typeof Command = cmdModule.default;
 	const usage = capitanoizeOclifUsage(cmd.usage);
 	let description = '';
 	// note: [^] matches any characters (including line breaks), achieving the

lib/command.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2020 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';
+
+export default abstract class extends Command {
+	/**
+	 * When set to true, command will be listed in `help`,
+	 * otherwise listed in `help --verbose` with secondary commands.
+	 */
+	public static primary = false;
+}