balena-cli 19.0.19 → 19.0.20

package/src/commands/os/versions.ts

@@ -40,8 +40,6 @@ export default class OsVersionsCmd extends Command {
 		}),
 	};
 
-	public static usage = 'os versions <type>';
-
 	public static flags = {
 		help: cf.help,
 		esr: Flags.boolean({

package/src/commands/preload/index.ts

@@ -80,8 +80,6 @@ export default class PreloadCmd extends Command {
 		}),
 	};
 
-	public static usage = 'preload <image>';
-
 	public static flags = {
 		fleet: cf.fleet,
 		commit: Flags.string({

package/src/commands/push/index.ts

@@ -99,8 +99,6 @@ export default class PushCmd extends Command {
 		}),
 	};
 
-	public static usage = 'push <fleetOrDevice>';
-
 	public static flags = {
 		source: Flags.string({
 			description: stripIndent`

package/src/commands/release/finalize.ts

@@ -40,8 +40,6 @@ export default class ReleaseFinalizeCmd extends Command {
 		'$ balena release finalize 1234567',
 	];
 
-	public static usage = 'release finalize <commitOrId>';
-
 	public static flags = {
 		help: cf.help,
 	};

package/src/commands/release/index.ts

@@ -42,8 +42,6 @@ export default class ReleaseCmd extends Command {
 		'$ balena release d3f3151f5ad25ca6b070aa4d08296aca --json',
 	];
 
-	public static usage = 'release <commitOrId>';
-
 	public static flags = {
 		json: cf.json,
 		help: cf.help,

package/src/commands/release/invalidate.ts

@@ -35,8 +35,6 @@ export default class ReleaseInvalidateCmd extends Command {
 		'$ balena release invalidate 1234567',
 	];
 
-	public static usage = 'release invalidate <commitOrId>';
-
 	public static flags = {
 		help: cf.help,
 	};

package/src/commands/release/validate.ts

@@ -34,8 +34,6 @@ export default class ReleaseValidateCmd extends Command {
 		'$ balena release validate 1234567',
 	];
 
-	public static usage = 'release validate <commitOrId>';
-
 	public static flags = {
 		help: cf.help,
 	};

package/src/commands/releases/index.ts

@@ -38,8 +38,6 @@ export default class ReleasesCmd extends Command {
 		'$ balena releases myorg/myfleet --json',
 	];
 
-	public static usage = 'releases <fleet>';
-
 	public static flags = {
 		json: cf.json,
 		help: cf.help,

package/src/commands/scan/index.ts

@@ -38,8 +38,6 @@ export default class ScanCmd extends Command {
 		'$ balena scan --verbose',
 	];
 
-	public static usage = 'scan';
-
 	public static flags = {
 		verbose: Flags.boolean({
 			default: false,

package/src/commands/settings/index.ts

@@ -27,8 +27,6 @@ export default class SettingsCmd extends Command {
 `;
 	public static examples = ['$ balena settings'];
 
-	public static usage = 'settings';
-
 	public static flags = {
 		help: cf.help,
 	};

package/src/commands/ssh/index.ts

@@ -75,8 +75,6 @@ export default class SshCmd extends Command {
 		}),
 	};
 
-	public static usage = 'ssh <fleetOrDevice> [service]';
-
 	public static flags = {
 		port: Flags.integer({
 			description: stripIndent`

package/src/commands/support/index.ts

@@ -52,8 +52,6 @@ export default class SupportCmd extends Command {
 		}),
 	};
 
-	public static usage = 'support <action>';
-
 	public static flags = {
 		device: Flags.string({
 			description: 'comma-separated list (no spaces) of device UUIDs',

package/src/commands/tag/rm.ts

@@ -45,8 +45,6 @@ export default class TagRmCmd extends Command {
 		}),
 	};
 
-	public static usage = 'tag rm <tagKey>';
-
 	public static flags = {
 		fleet: {
 			...cf.fleet,

package/src/commands/tag/set.ts

@@ -58,7 +58,6 @@ export default class TagSetCmd extends Command {
 
 	// Required for supporting empty string ('') `value` args.
 	public static strict = false;
-	public static usage = 'tag set <tagKey> [value]';
 
 	public static flags = {
 		fleet: {

package/src/commands/tags/index.ts

@@ -38,8 +38,6 @@ export default class TagsCmd extends Command {
 		'$ balena tags --release b376b0e544e9429483b656490e5b9443b4349bd6',
 	];
 
-	public static usage = 'tags';
-
 	public static flags = {
 		fleet: {
 			...cf.fleet,

package/src/commands/tunnel/index.ts

@@ -78,8 +78,6 @@ export default class TunnelCmd extends Command {
 		}),
 	};
 
-	public static usage = 'tunnel <deviceOrFleet>';
-
 	public static flags = {
 		port: Flags.string({
 			description:

package/src/commands/util/available-drives.ts

@@ -27,8 +27,6 @@ export default class UtilAvailableDrivesCmd extends Command {
 		Does not list system drives.
 	`;
 
-	public static usage = 'util available-drives';
-
 	public static flags = {
 		help: cf.help,
 	};

package/src/commands/version/index.ts

@@ -49,8 +49,6 @@ export default class VersionCmd extends Command {
 		`$ balena -v`,
 	];
 
-	public static usage = 'version';
-
 	public static offlineCompatible = true;
 
 	public static flags = {

package/src/commands/whoami/index.ts

@@ -27,8 +27,6 @@ export default class WhoamiCmd extends Command {
 
 	public static examples = ['$ balena whoami'];
 
-	public static usage = 'whoami';
-
 	public static authenticated = true;
 
 	public async run() {

package/src/help.ts

@@ -14,9 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { Command } from '@oclif/core';
 import { Help } from '@oclif/core';
 import * as indent from 'indent-string';
 import { getChalk } from './utils/lazy';
+import type { ResolvableReturnType } from 'balena-sdk/typings/utils';
 
 // Partially overrides standard implementation of help plugin
 // https://github.com/oclif/plugin-help/blob/master/src/index.ts
@@ -37,8 +39,6 @@ function getHelpSubject(args: string[]): string | undefined {
 }
 
 export default class BalenaHelp extends Help {
-	public static usage: 'help [command]';
-
 	public async showHelp(argv: string[]) {
 		const chalk = getChalk();
 		const subject = getHelpSubject(argv);
@@ -96,9 +96,9 @@ export default class BalenaHelp extends Help {
 			})
 			.filter((c): c is (typeof commands)[0] => !!c);
 
-		let usageLength = 0;
+		let cmdLength = 0;
 		for (const cmd of primaryCommands) {
-			usageLength = Math.max(usageLength, cmd.usage?.length || 0);
+			cmdLength = Math.max(cmdLength, cmd.id.length);
 		}
 
 		let additionalCmdSection: string[];
@@ -112,16 +112,15 @@ export default class BalenaHelp extends Help {
 			// Find longest usage, and pad usage of first command in each category
 			// This is to ensure that both categories align visually
 			for (const cmd of additionalCommands) {
-				usageLength = Math.max(usageLength, cmd.usage?.length || 0);
+				cmdLength = Math.max(cmdLength, cmd.id.length);
 			}
 
 			if (
-				typeof primaryCommands[0].usage === 'string' &&
-				typeof additionalCommands[0].usage === 'string'
+				typeof primaryCommands[0].id === 'string' &&
+				typeof additionalCommands[0].id === 'string'
 			) {
-				primaryCommands[0].usage = primaryCommands[0].usage.padEnd(usageLength);
-				additionalCommands[0].usage =
-					additionalCommands[0].usage.padEnd(usageLength);
+				primaryCommands[0].id = primaryCommands[0].id.padEnd(cmdLength);
+				additionalCommands[0].id = additionalCommands[0].id.padEnd(cmdLength);
 			}
 
 			additionalCmdSection = [
@@ -145,7 +144,7 @@ prevent exit with an error as per Deprecation Policy
 See: https://git.io/JRHUW#deprecation-policy`,
 			],
 		];
-		globalOps[0][0] = globalOps[0][0].padEnd(usageLength);
+		globalOps[0][0] = globalOps[0][0].padEnd(cmdLength);
 
 		const { deprecationPolicyNote, reachingOut } =
 			require('./utils/messages') as typeof import('./utils/messages');
@@ -185,15 +184,20 @@ See: https://git.io/JRHUW#deprecation-policy`,
 		return outLines.join('\n');
 	}
 
-	protected formatCommands(commands: any[]): string {
+	protected formatCommands(
+		commands: Array<
+			Command.Loadable | ResolvableReturnType<Command.Loadable['load']>
+		>,
+	): string {
 		if (commands.length === 0) {
 			return '';
 		}
 
 		const body = this.renderList(
-			commands
-				.filter((c) => c.usage != null && c.usage !== '')
-				.map((c) => [c.usage, this.formatDescription(c.description)]),
+			commands.map((c) => [
+				c.id.replaceAll(':', ' '),
+				this.formatDescription(c.description),
+			]),
 			{
 				spacer: '\n',
 				stripAnsi: this.opts.stripAnsi,

package/src/hooks/prerun/track.ts

@@ -34,13 +34,11 @@ export const trackPromise = new Promise((resolve) => {
  */
 const hook: Hook<'prerun'> = async function (options) {
 	const events = await import('../../events');
-	const usage: string | string[] | undefined = options.Command.usage;
-	const cmdSignature =
-		usage == null ? '*' : typeof usage === 'string' ? usage : usage.join(' ');
+	const cmd = options.Command.id;
 
 	// Intentionally do not await for the track promise here, in order to
 	// run the command tracking and the command itself in parallel.
-	trackResolve(events.trackCommand(cmdSignature));
+	trackResolve(events.trackCommand(cmd));
 };
 
 export default hook;

package/src/utils/oclif-utils.ts

@@ -15,33 +15,7 @@
  * limitations under the License.
  */
 
-/**
- * This class is a partial copy-and-paste of
- * @oclif/plugin-help/command/CommandHelp, which is used to generate oclif's
- * command help output.
- */
-export class CommandHelp {
-	constructor(public command: { args?: { [name: string]: any } }) {}
-
-	protected arg(name: string, required: boolean): string {
-		name = name.toUpperCase();
-		if (required) {
-			return `${name}`;
-		}
-		return `[${name}]`;
-	}
-
-	public defaultUsage(): string {
-		const argsObject = this.command.args ?? {};
-
-		return Object.entries(argsObject)
-			.filter(([_name, { hidden }]) => !hidden)
-			.map(([name, { required }]) => this.arg(name, required))
-			.join(' ');
-	}
-}
-
-/** Convert e.g. 'env add NAME [VALUE]' to 'env add <name> [value]' */
+/** Convert e.g. 'env set NAME [VALUE]' to 'env set <name> [value]' */
 export function capitanoizeOclifUsage(
 	oclifUsage: string | string[] | undefined,
 ): string {