Merge pull request #1943 from balena-io/convert-os-versions

Convert `os versions` to oclif, typescript

automation/capitanodoc/capitanodoc.ts

@@ -117,7 +117,11 @@ const capitanoDoc = {
 		},
 		{
 			title: 'OS',
-			files: ['build/actions/os.js', 'build/actions-oclif/os/configure.js'],
+			files: [
+				'build/actions/os.js',
+				'build/actions-oclif/os/configure.js',
+				'build/actions-oclif/os/versions.js',
+			],
 		},
 		{
 			title: 'Config',

doc/cli.markdown

@@ -1521,13 +1521,21 @@ device UUID
 
 ## os versions <type>
 
-Use this command to show the available balenaOS versions for a certain device type.
-Check available types with `balena devices supported`
+Show the available balenaOS versions for the given device type.
+Check available types with `balena devices supported`.
 
-Example:
+Examples:
 
 	$ balena os versions raspberrypi3
 
+### Arguments
+
+#### TYPE
+
+device type
+
+### Options
+
 ## os download <type>
 
 Use this command to download an unconfigured os image for a certain device type.

lib/actions-oclif/os/versions.ts

@@ -0,0 +1,66 @@
+/**
+ * @license
+ * Copyright 2016-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 { flags } from '@oclif/command';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	type: string;
+}
+
+export default class OsVersionsCmd extends Command {
+	public static description = stripIndent`
+		Show available balenaOS versions for the given device type.
+
+		Show the available balenaOS versions for the given device type.
+		Check available types with \`balena devices supported\`.
+	`;
+
+	public static examples = ['$ balena os versions raspberrypi3'];
+
+	public static args = [
+		{
+			name: 'type',
+			description: 'device type',
+		},
+	];
+
+	public static usage = 'os versions <type>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
+	};
+
+	public async run() {
+		const { args: params } = this.parse<FlagsDef, ArgsDef>(OsVersionsCmd);
+
+		const {
+			versions: vs,
+			recommended,
+		} = await getBalenaSdk().models.os.getSupportedVersions(params.type);
+
+		vs.forEach((v) => {
+			console.log(`v${v}` + (v === recommended ? ' (recommended)' : ''));
+		});
+	}
+}

lib/actions/os.js

@@ -54,30 +54,6 @@ const resolveVersion = function (deviceType, version) {
 		});
 };
 
-export const versions = {
-	signature: 'os versions <type>',
-	description: 'show the available balenaOS versions for the given device type',
-	help: `\
-Use this command to show the available balenaOS versions for a certain device type.
-Check available types with \`balena devices supported\`
-
-Example:
-
-	$ balena os versions raspberrypi3\
-`,
-	action(params) {
-		const balena = getBalenaSdk();
-
-		return balena.models.os
-			.getSupportedVersions(params.type)
-			.then(({ versions: vs, recommended }) => {
-				vs.forEach((v) => {
-					console.log(formatVersion(v, v === recommended));
-				});
-			});
-	},
-};
-
 export const download = {
 	signature: 'os download <type>',
 	description: 'download an unconfigured os image',

lib/app-capitano.ts

@@ -47,7 +47,6 @@ capitano.globalOption({
 capitano.command(actions.help.help);
 
 // ---------- OS Module ----------
-capitano.command(actions.os.versions);
 capitano.command(actions.os.download);
 capitano.command(actions.os.buildConfig);
 capitano.command(actions.os.initialize);

lib/preparser.ts

@@ -180,6 +180,7 @@ export const convertedCommands = [
 	'logs',
 	'note',
 	'os:configure',
+	'os:versions',
 	'scan',
 	'settings',
 	'ssh',

tests/commands/help.spec.ts

@@ -83,7 +83,7 @@ Additional commands:
     os configure <image>                  configure a previously downloaded balenaOS image
     os download <type>                    download an unconfigured os image
     os initialize <image>                 initialize an os image
-    os versions <type>                    show the available balenaOS versions for the given device type
+    os versions <type>                    show available balenaOS versions for the given device type
     settings                              print current settings
     tag rm <tagkey>                       remove a tag from an application, device or release
     tag set <tagkey> [value]              set a tag on an application, device or release