feat(cli)!: remove setup command (#432)

Author: chenjiahan

packages/rstack/src/cli/commandHelp.ts

@@ -46,8 +46,7 @@ export type HelpTopic =
   | 'fmt'
   | 'staged'
   | 'hooks'
-  | 'hooks uninstall'
-  | 'setup';
+  | 'hooks uninstall';
 
 const CONFIG_OPTION: HelpItem = [
   '-c, --config <path>',
@@ -528,23 +527,6 @@ const HELP_DEFINITIONS = {
       },
     ],
   },
-  setup: {
-    usage: 'rs setup [options]',
-    description: 'Install Git hooks in the current repository',
-    sections: [
-      {
-        title: 'Options',
-        items: [
-          ['-f, --force', 'Install despite an existing Git hooks setup'],
-          [
-            '--hooks-dir <path>',
-            'Specify hooks directory relative to the Git repository root',
-          ],
-          HELP_OPTION,
-        ],
-      },
-    ],
-  },
 } satisfies Record<HelpTopic, HelpDefinition>;
 
 const renderItems = (items: readonly HelpItem[]): string => {

packages/rstack/src/cli/commands.ts

@@ -252,12 +252,12 @@ export async function setupCommands(): Promise<void> {
     return;
   }
 
-  if (command === 'hooks' || command === 'setup') {
+  if (command === 'hooks') {
     const { runHooksCLI } = await import(
       /* rspackChunkName: 'hooks' */
       '../setup/index.ts'
     );
-    await runHooksCLI(args.slice(1), command);
+    await runHooksCLI(args.slice(1));
     return;
   }
 

packages/rstack/src/setup/index.ts

@@ -4,10 +4,7 @@ import { printCommandHelp } from '../cli/help.ts';
 import { installHooks } from './install.ts';
 import { uninstallHooks } from './uninstall.ts';
 
-const runInstallCLI = async (
-  args: string[],
-  command: 'hooks' | 'setup',
-): Promise<void> => {
+const runInstallCLI = async (args: string[]): Promise<void> => {
   const { values } = parseArgs({
     args,
     options: {
@@ -29,7 +26,7 @@ const runInstallCLI = async (
   const hooksDir = hooksDirs?.[0];
 
   if (values.help) {
-    await printCommandHelp(command);
+    await printCommandHelp('hooks');
     return;
   }
 
@@ -122,14 +119,11 @@ const runUninstallCLI = async (args: string[]): Promise<void> => {
   throw new Error(result.message);
 };
 
-export const runHooksCLI = async (
-  args: string[],
-  command: 'hooks' | 'setup' = 'hooks',
-): Promise<void> => {
-  if (command === 'hooks' && args[0] === 'uninstall') {
+export const runHooksCLI = async (args: string[]): Promise<void> => {
+  if (args[0] === 'uninstall') {
     await runUninstallCLI(args.slice(1));
     return;
   }
 
-  await runInstallCLI(args, command);
+  await runInstallCLI(args);
 };

packages/rstack/tests/cli/setup/index.test.ts

@@ -17,10 +17,6 @@ rs hooks uninstall
 
 Run `rs hooks` without a subcommand to install or update hooks.
 
-:::tip Alias
-`rs setup` is an alias for `rs hooks`.
-:::
-
 ## Install hooks
 
 By default, hook scripts are stored in `.rstack/hooks` at the Git repository root. If the current directory is outside a Git repository, the command skips installation.

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

@@ -17,10 +17,6 @@ rs hooks uninstall
 
 直接运行 `rs hooks` 即可安装或更新 hooks。
 
-:::tip 别名
-`rs setup` 是 `rs hooks` 的别名。
-:::
-
 ## 安装 hooks \{#install-hooks}
 
 hook 脚本默认存放在 Git 仓库根目录的 `.rstack/hooks` 中。如果当前目录不在 Git 仓库内，命令会跳过安装。