balena-cli/automation/capitanodoc/index.ts

/**
 * @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 * as path from 'path';
import { getCapitanoDoc } from './capitanodoc';
import { Category, Document, OclifCommand } from './doc-types';
import * as markdown from './markdown';
import { stripIndent } from '../../lib/utils/lazy';

/**
 * Generates the markdown document (as a string) for the CLI documentation
 * page on the web: https://www.balena.io/docs/reference/cli/
 */
export async function renderMarkdown(): Promise<string> {
	const capitanodoc = await getCapitanoDoc();
	const result: Document = {
		title: capitanodoc.title,
		introduction: capitanodoc.introduction,
		categories: [],
	};

	for (const commandCategory of capitanodoc.categories) {
		const category: Category = {
			title: commandCategory.title,
			commands: [],
		};

		for (const jsFilename of commandCategory.files) {
			category.commands.push(...importOclifCommands(jsFilename));
		}
		result.categories.push(category);
	}

	return markdown.render(result);
}

// Help is now managed via a plugin
// This fake command allows capitanodoc to include help in docs
class FakeHelpCommand {
	description = stripIndent`
		List balena commands, or get detailed help for a specific command.

		List balena commands, or get detailed help for a specific command.
	`;

	examples = [
		'$ balena help',
		'$ balena help login',
		'$ balena help os download',
	];

	args = {
		command: {
			description: 'command to show help for',
		},
	};

	usage = 'help [command]';

	flags = {
		verbose: {
			description: 'show additional commands',
			char: '-v',
		},
	};
}

function importOclifCommands(jsFilename: string): OclifCommand[] {
	// TODO: Currently oclif commands with no `usage` overridden will cause
	//  an error when parsed.  This should be improved so that `usage` does not have
	//  to be overridden if not necessary.

	const command: OclifCommand =
		jsFilename === 'help'
			? (new FakeHelpCommand() as unknown as OclifCommand)
			: (require(path.join(process.cwd(), jsFilename)).default as OclifCommand);

	return [command];
}

/**
 * Print the CLI docs markdown to stdout.
 * See package.json for how the output is redirected to a file.
 */
async function printMarkdown() {
	try {
		console.log(await renderMarkdown());
	} catch (error) {
		console.error(error);
		process.exitCode = 1;
	}
}

// tslint:disable-next-line:no-floating-promises
printMarkdown();