feat(cli): support file arguments in rs check (#453)

Author: chenjiahan

packages/rstack/src/cli/commandHelp.ts

@@ -148,7 +148,7 @@ const HELP_DEFINITIONS = {
     ],
   },
   check: {
-    usage: 'rs check [options]',
+    usage: 'rs check [options] [files...]',
     description: 'Run static checks, including lint and format',
     sections: [
       {

packages/rstack/src/cli/commands.ts

@@ -157,21 +157,27 @@ async function runRslintCLI(args: string[]): Promise<void> {
 }
 
 async function runCheckCLI(args: string[]): Promise<void> {
-  const { values } = parseArgs({
+  const { values, positionals } = parseArgs({
     args,
     options: {
       'type-check': { type: 'boolean' },
       help: { type: 'boolean', short: 'h' },
     },
-    allowPositionals: false,
+    allowPositionals: true,
     strict: true,
   });
 
   if (values.help) {
     return printCommandHelp('check');
   }
 
-  await runRslintCLI(values.typeCheck ? ['--type-check'] : []);
+  // Keep file arguments after `--` when forwarding them so names beginning
+  // with a hyphen are not reinterpreted as child-command options.
+  const fileArgs = positionals.length > 0 ? ['--', ...positionals] : [];
+  await runRslintCLI([
+    ...(values.typeCheck ? ['--type-check'] : []),
+    ...fileArgs,
+  ]);
   if (process.exitCode) {
     return;
   }
@@ -185,7 +191,10 @@ async function runCheckCLI(args: string[]): Promise<void> {
     /* rspackChunkName: 'fmt' */
     '../fmt/cli.ts'
   );
-  await runFmtCLI(['--check'], { fixCommand: 'rs fmt', loadedConfig });
+  await runFmtCLI(['--check', ...fileArgs], {
+    fixCommand: 'rs fmt',
+    loadedConfig,
+  });
 }
 
 export async function setupCommands(): Promise<void> {

packages/rstack/tests/cli/__snapshots__/check.test.ts.snap

@@ -4,7 +4,7 @@ exports[`displays check help without loading config 1`] = `
 "Rstack v<version>
 
 Usage:
-  $ rs check [options]
+  $ rs check [options] [files...]
 
 Run static checks, including lint and format
 

packages/rstack/tests/cli/check.test.ts

@@ -48,6 +48,33 @@ test('runs lint followed by a formatting check', () => {
   expect(formatted.stderr).toBe('');
 });
 
+test('passes file arguments to lint and the formatting check', () => {
+  writeLintConfig();
+  writeProjectFile('src/selected-a.ts', 'const selectedA = true;\n');
+  writeProjectFile('src/selected-b.ts', 'const selectedB = true;\n');
+  writeProjectFile('src/unselected-lint-error.ts', 'debugger;\n');
+  writeProjectFile('src/unselected-format-error.ts', 'const value=true');
+
+  const result = runCheck(['src/selected-a.ts', 'src/selected-b.ts']);
+
+  expect(result.status).toBe(0);
+  expect(result.stdout).toContain('Format check passed in');
+  expect(result.stdout).toContain('(2 files)');
+  expect(result.stderr).toBe('');
+});
+
+test('supports file arguments after the option terminator', () => {
+  writeLintConfig();
+  writeProjectFile('--selected.ts', 'const selected = true;\n');
+
+  const result = runCheck(['--', '--selected.ts']);
+
+  expect(result.status).toBe(0);
+  expect(result.stdout).toContain('Format check passed in');
+  expect(result.stdout).toContain('(1 file)');
+  expect(result.stderr).toBe('');
+});
+
 test('enables type checking only with --type-check', () => {
   writeLintConfig();
   writeProjectFile(

website/docs/en/guide/cli/check.mdx

@@ -9,7 +9,19 @@ The `rs check` command combines linting, formatting, and optional TypeScript typ
 ## Usage
 
 ```bash
-rs check [options]
+rs check [options] [files...]
+```
+
+Pass files or directories to limit both linting and formatting to those paths:
+
+```bash
+rs check src/index.ts packages/utils
+```
+
+The same file arguments are passed to both commands, so the example above is equivalent to:
+
+```bash
+rs lint src/index.ts packages/utils && rs fmt --check src/index.ts packages/utils
 ```
 
 ## Checks

website/docs/zh/guide/cli/check.mdx

@@ -9,7 +9,19 @@ description: '同时运行 lint 和格式检查，并可选启用 TypeScript 类
 ## 用法 \{#usage}
 
 ```bash
-rs check [options]
+rs check [options] [files...]
+```
+
+传入文件或目录，可以将 lint 和格式检查都限制在这些路径中：
+
+```bash
+rs check src/index.ts packages/utils
+```
+
+相同的文件参数会同时传给两个命令，因此上述示例等同于：
+
+```bash
+rs lint src/index.ts packages/utils && rs fmt --check src/index.ts packages/utils
 ```
 
 ## 检查内容 \{#checks}