feat: add check command (#59)

Author: AdrianGonz97

packages/cli/bin.ts

@@ -5,8 +5,9 @@ import { program } from 'commander';
 import { add } from './commands/add.js';
 import { create } from './commands/create.js';
 import { migrate } from './commands/migrate.js';
+import { check } from './commands/check.js';
 import { helpConfig } from './common.js';
 
 program.name(pkg.name).version(pkg.version, '-v').configureHelp(helpConfig);
-program.addCommand(create).addCommand(add).addCommand(migrate);
+program.addCommand(create).addCommand(add).addCommand(migrate).addCommand(check);
 program.parse();

packages/cli/commands/add.ts

@@ -54,7 +54,7 @@ const defaultPkgPath = findUp(process.cwd(), 'package.json');
 const defaultCwd = defaultPkgPath ? path.dirname(defaultPkgPath) : undefined;
 
 export const add = new Command('add')
-	.description('Applies specified adders into a project')
+	.description('applies specified adders into a project')
 	.argument('[adder...]', 'adders to install')
 	.option('-C, --cwd <path>', 'path to working directory', defaultCwd)
 	.option('--no-install', 'skips installing dependencies')

packages/cli/commands/check.ts

@@ -0,0 +1,47 @@
+import { createRequire } from 'node:module';
+import { execSync } from 'node:child_process';
+import pc from 'picocolors';
+import { Command } from 'commander';
+import { resolveCommand } from 'package-manager-detector/commands';
+import { getUserAgent } from '../common.ts';
+
+const require = createRequire(import.meta.url);
+
+export const check = new Command('check')
+	.description('a CLI for checking your Svelte code')
+	// flags that we'll want to pass to `svelte-check`
+	.allowUnknownOption(true)
+	.option('-C, --cwd <path>', 'path to working directory', process.cwd())
+	.configureHelp({
+		formatHelp() {
+			// we'll pass the responsibility of presenting the help menu over to `svelte-check`
+			runCheck(process.cwd(), ['--help']);
+			return '';
+		}
+	})
+	.action((options, check: Command) => {
+		const cwd: string = options.cwd;
+		const args: string[] = check.args;
+
+		runCheck(cwd, args);
+	});
+
+function runCheck(cwd: string, args: string[]) {
+	const pm = getUserAgent() ?? 'npm';
+
+	// validates that `svelte-check` is locally installed
+	try {
+		require.resolve('svelte-check', { paths: [cwd] });
+	} catch {
+		const cmd = resolveCommand(pm, 'add', ['-D', 'svelte-check'])!;
+		console.error(
+			`'svelte-check' is not installed locally. Install it with: ${pc.bold(`${cmd.command} ${cmd.args.join(' ')}`)}`
+		);
+		process.exit(1);
+	}
+
+	// avoids printing the stack trace for `sv` when `svelte-check` exits with an error code
+	try {
+		execSync(`npx svelte-check ${args.join(' ')}`, { stdio: 'inherit', cwd });
+	} catch {}
+}

packages/cli/commands/create.ts

@@ -45,7 +45,7 @@ export const create = new Command('create')
 			const highlight = (str: string) => pc.bold(pc.cyan(str));
 
 			let i = 1;
-			const initialSteps = [];
+			const initialSteps: string[] = [];
 			const relative = path.relative(process.cwd(), directory);
 			const pm = await common.guessPackageManager(cwd);
 			if (relative !== '') {

packages/cli/commands/migrate.ts

@@ -2,7 +2,7 @@ import { execSync } from 'node:child_process';
 import { Command } from 'commander';
 
 export const migrate = new Command('migrate')
-	.description('A CLI for migrating Svelte(Kit) codebases')
+	.description('a CLI for migrating Svelte(Kit) codebases')
 	.argument('<migration>', 'migration to run')
 	.option('-C, --cwd <path>', 'path to working directory', process.cwd())
 	.configureHelp({

packages/cli/common.ts

@@ -96,7 +96,7 @@ export async function guessPackageManager(cwd: string): Promise<AgentName> {
 	return pm?.name ?? getUserAgent() ?? 'npm';
 }
 
-function getUserAgent() {
+export function getUserAgent() {
 	const userAgent = process.env.npm_config_user_agent;
 	if (!userAgent) return undefined;
 	const pmSpec = userAgent.split(' ')[0];