feat(app-tools): enable Rsbuild CLI shortcuts (#6610)

chenjiahan · web-flow · commit 5fc95f779b79 · 2024-12-05T07:40:05.000Z
diff --git a/.changeset/afraid-socks-jam.md b/.changeset/afraid-socks-jam.md
@@ -0,0 +1,7 @@
+---
+'@modern-js/app-tools': patch
+'@modern-js/uni-builder': patch
+'@modern-js/utils': patch
+---
+
+feat(app-tools): enable Rsbuild CLI shortcuts
diff --git a/packages/cli/uni-builder/src/shared/parseCommonConfig.ts b/packages/cli/uni-builder/src/shared/parseCommonConfig.ts
@@ -316,14 +316,14 @@ export async function parseCommonConfig(
     };
   }
 
-  const { dev: RsbuildDev, server } = transformToRsbuildServerOptions(
+  const { dev: rsbuildDev, server } = transformToRsbuildServerOptions(
     dev || {},
     devServer || {},
   );
 
   rsbuildConfig.server = removeUndefinedKey(server);
 
-  rsbuildConfig.dev = removeUndefinedKey(RsbuildDev);
+  rsbuildConfig.dev = removeUndefinedKey(rsbuildDev);
   rsbuildConfig.html = html;
   rsbuildConfig.output = output;
 
diff --git a/packages/solutions/app-tools/src/config/default.ts b/packages/solutions/app-tools/src/config/default.ts
@@ -11,6 +11,12 @@ export function createDefaultConfig(
     // `dev.port` should not have a default value
     // because we will use `server.port` by default
     port: undefined,
+    cliShortcuts: {
+      help: false,
+      // does not support restart server and print urls yet
+      custom: (shortcuts = []) =>
+        shortcuts.filter(({ key }) => key !== 'r' && key !== 'u'),
+    },
   };
 
   const output: AppUserConfig['output'] = {
diff --git a/packages/toolkit/utils/src/cli/prettyInstructions.ts b/packages/toolkit/utils/src/cli/prettyInstructions.ts
@@ -142,5 +142,11 @@ export const prettyInstructions = (appContext: any, config: any) => {
     );
   }
 
+  if (config.dev?.cliShortcuts) {
+    message += `  ${chalk.dim('> press')} ${chalk.bold(
+      'h + enter',
+    )} ${chalk.dim('to show shortcuts')}\n`;
+  }
+
   return message;
 };
