index.ts

/**
 * Demo showing how `tsc --help` can be re-implemented with cleye
 *
 * Usage:
 *  npx esno examples/tsc --help
 */

import assert from 'assert';
import { cli } from '../../src';

// https://github.com/microsoft/TypeScript/blob/7a12909ae3f03b1feed19df2082aa84e5c7a5081/src/executeCommandLine/executeCommandLine.ts#L111
function blue(string_: string) {
	return `\u001B[94m${string_}\u001B[39m`;
}

const targetType = ['es3', 'es5', 'es6', 'es2015', 'es2016', 'es2017', 'es2018', 'es2019', 'es2020', 'es2021', 'esnext'];

const moduleTypes = ['none', 'commonjs', 'amd', 'system', 'umd', 'es6', 'es2015', 'es2020', 'esnext'] as const;

const libraryTypes = ['es5', 'es6', 'es2015', 'es7', 'es2016', 'es2017', 'es2018', 'es2019', 'es2020', 'es2021', 'esnext', 'dom', 'dom.iterable', 'webworker', 'webworker.importscripts', 'webworker.iterable', 'scripthost', 'es2015.core', 'es2015.coll ection', 'es2015.generator', 'es2015.iterable', 'es2015.promise', 'es2015.proxy', 'es2015.reflect', 'es2015 .symbol', 'es2015.symbol.wellknown', 'es2016.array.include', 'es2017.object', 'es2017.sharedmemory', 'es2 017.string', 'es2017.intl', 'es2017.typedarrays', 'es2018.asyncgenerator', 'es2018.asynciterable', 'es201 8.intl', 'es2018.promise', 'es2018.regexp', 'es2019.array', 'es2019.object', 'es2019.string', 'es2019.symbo l', 'es2020.bigint', 'es2020.promise', 'es2020.sharedmemory', 'es2020.string', 'es2020.symbol.wellknown', 'es2020.intl', 'es2021.promise', 'es2021.string', 'es2021.weakref', 'esnext.array', 'esnext.symbol', 'esnext .asynciterable', 'esnext.intl', 'esnext.bigint', 'esnext.string', 'esnext.promise', 'esnext.weakref'] as const;

const jsxTypes = [undefined, 'preserve', 'react-native', 'react', 'react-jsx', 'react-jsxdev'] as const;

const commandLineFlags = {
	help: {
		type: Boolean,
		alias: 'h',
		description: 'Print this message.',
	},
	watch: {
		type: Boolean,
		alias: 'w',
		description: 'Watch input files.',
	},
	all: {
		type: Boolean,
		description: 'Show all compiler options.',
	},
	version: {
		type: Boolean,
		alias: 'v',
		description: 'Print the compiler\'s version.',
	},
	init: {
		type: Boolean,
		description: 'Initializes a TypeScript project and creates a tsconfig.json file.',
	},
	project: {
		type: Boolean,
		alias: 'p',
		description: 'Compile the project given the path to its configuration file, or to a folder with a \'tsconfig.json\'.',
	},
	build: {
		type: Boolean,
		alias: 'b',
		description: 'Build one or more projects and their dependencies, if out of date',
	},
	showConfig: {
		type: Boolean,
		description: 'Print the final configuration instead of building.',
	},
};

const commonCompilerOptions = {
	pretty: {
		type: Boolean,
		description: 'Enable color and formatting in TypeScript\'s output to make compiler errors easier to read',
		default: true,
	},

	target: {
		type: function TargetType(value: typeof targetType[number]) {
			assert(targetType.includes(value), 'Invalid target type');
			return value;
		},
		alias: 't',
		description: `Set the JavaScript language version for emitted JavaScript and include compatible library declarations.\none of: ${targetType.join(', ')}`,
		default: 'ES3',
	},

	module: {
		type: function ModuleType(value: typeof moduleTypes[number]) {
			assert(moduleTypes.includes(value), 'Invalid module type');
			return value;
		},
		alias: 'm',
		description: `Specify what module code is generated.\none of: ${moduleTypes.join(', ')}`,
	},

	lib: {
		type: [
			function LibraryType(value: typeof libraryTypes[number]) {
				assert(libraryTypes.includes(value), 'Invalid library type');
				return value;
			},
		] as const,
		description: `Specify a set of bundled library declaration files that describe the target runtime environment.\none or more: ${libraryTypes.join(', ')}`,
	},

	allowJs: {
		type: Boolean,
		description: 'Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.',

	},

	checkJs: {
		type: Boolean,
		description: 'Enable error reporting in type-checked JavaScript files.',
	},

	jsx: {
		type: function JsxType(value: typeof jsxTypes[number]) {
			assert(jsxTypes.includes(value), 'Invalid jsx type');
			return value;
		},
		description: `Specify what JSX code is generated.\none of: ${jsxTypes.join(', ')}`,
	},

	declaration: {
		type: Boolean,
		alias: 'd',
		description: 'Generate .d.ts files from TypeScript and JavaScript files in your project.',
	},

	declarationMap: {
		type: Boolean,
		description: 'Create sourcemaps for d.ts files.',
	},

	emitDeclarationOnly: {
		type: Boolean,
		description: 'Only output d.ts files and not JavaScript files.',
	},

	sourceMap: {
		type: Boolean,
		description: 'Create source map files for emitted JavaScript files.',
	},

	outFile: {
		type: String,
		description: 'Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.',
	},

	outDir: {
		type: String,
		description: 'Specify an output folder for all emitted files.',
	},

	removeComments: {
		type: Boolean,
		description: 'Disable emitting comments.',
	},

	noEmit: {
		type: Boolean,
		description: 'Disable emitting files from a compilation.',
	},

	strict: {
		type: Boolean,
		description: 'Enable all strict type-checking options.',
	},

	types: {
		type: String,
		description: 'Specify type package names to be included without being referenced in a source file.',
	},

	esModuleInterop: {
		type: Boolean,
		description: 'Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.',
	},
};

const tableBreakpoints = {
	'> 80': [
		{
			align: 'right',
			width: 'content-width',
			paddingLeft: 2,
			paddingRight: 2,
			paddingBottom: 1,
		},
		{
			paddingBottom: 1,
		},
	],
	'> 0': [
		{
			width: '100%',
			paddingLeft: 2,
			paddingRight: 2,
		},
		{
			width: '100%',
			paddingLeft: 2,
			paddingRight: 2,
			paddingBottom: 1,
		},
	],
};

const argv = cli({
	flags: {
		...commandLineFlags,
		...commonCompilerOptions,
	},

	help: {
		usage: false,
		examples: [
			blue('tsc'),
			'Compiles the current project (tsconfig.json in the working directory.)',

			'',

			blue('tsc app.ts util.ts'),
			'Ignoring tsconfig.json, compiles the specified files with default compiler options.',

			'',

			blue('tsc -b'),
			'Build a composite project in the working directory.',

			'',

			blue('tsc --init'),
			'Creates a tsconfig.json with the recommended settings in the working directory.',

			'',

			blue('tsc -p ./path/to/tsconfig.json'),
			'Compiles the TypeScript project located at the specified path.',

			'',

			blue('tsc --help --all'),
			'An expanded version of this information, showing all possible compiler options',

			'',

			blue('tsc --noEmit'),
			blue('tsc --target esnext'),
			'Compiles the current project, with additional settings.',
		],

		render(nodes, renderers) {
			const [flags, commonCommands] = nodes;

			commonCommands.data.title = 'COMMON COMMANDS';
			commonCommands.data.body = `\n${commonCommands.data.body}`;
			nodes.splice(1, 0, commonCommands);

			const { tableData: flagsTableData } = flags.data.body.data;

			renderers.flagName = function (flag) {
				const flagName = `--${flag.name}`;
				return blue(flagName + (flag.aliasFormatted ? `, ${flag.aliasFormatted}` : ''));
			};

			return renderers.render([
				'tsc: The TypeScript Compiler - Version 0.0.0\n',
				commonCommands,
				{
					type: 'section',
					data: {
						title: 'COMMAND LINE FLAGS\n',
						body: {
							type: 'table',
							data: {
								tableBreakpoints,
								tableData: flagsTableData.filter(
									(
										[flagName]: [{ data: { name: string }}],
									) => flagName.data.name in commandLineFlags,
								),
							},
						},
						indentBody: 0,
					},
				},
				{
					type: 'section',
					data: {
						title: 'COMMON COMPILER OPTIONS\n',
						body: {
							type: 'table',
							data: {
								tableBreakpoints,
								tableData: flagsTableData.filter(
									(
										[flagName]: [{ data: { name: string }}],
									) => flagName.data.name in commonCompilerOptions,
								),
							},
						},
						indentBody: 0,
					},
				},
				'You can learn about all of the compiler options at https://aka.ms/tsconfig-reference',
			]);
		},
	},
});

console.log(argv);