feat(server): support launch editor

e2e/cases/server/custom-server/scripts/pure-server.mjs

@@ -44,7 +44,13 @@ export async function startDevServerPure(fixtures) {
     res.end('Hello World!');
   });
 
-  app.use(...middlewares);
+  middlewares.forEach((item) => {
+    if (Array.isArray(item)) {
+      app.use(...item);
+    } else {
+      app.use(item);
+    }
+  });
 
   app.get('/bbb', (_req, res) => {
     res.end('Hello Express!');

e2e/cases/server/custom-server/scripts/server.mjs

@@ -32,7 +32,13 @@ export async function startDevServer(fixtures) {
     res.end('Hello World!');
   });
 
-  app.use(...middlewares);
+  middlewares.forEach((item) => {
+    if (Array.isArray(item)) {
+      app.use(...item);
+    } else {
+      app.use(item);
+    }
+  });
 
   app.get('/bbb', (_req, res) => {
     res.end('Hello Express!');

packages/core/compiled/launch-editor-middleware/index.d.ts

@@ -0,0 +1 @@
+export = any;

packages/core/compiled/launch-editor-middleware/license

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-present, Yuxi (Evan) You
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

packages/core/compiled/launch-editor-middleware/package.json

@@ -0,0 +1 @@
+{"name":"launch-editor-middleware","author":"Evan You","version":"2.6.1","license":"MIT","types":"index.d.ts","type":"commonjs"}

packages/core/src/server/devServer.ts

@@ -203,7 +203,13 @@ export async function startDevServer<
           compileMiddlewareAPI,
         });
 
-        devMiddlewares.middlewares.forEach((m) => middlewares.use(m));
+        devMiddlewares.middlewares.forEach((item) => {
+          if (Array.isArray(item)) {
+            middlewares.use(...item);
+          } else {
+            middlewares.use(item);
+          }
+        });
 
         middlewares.use(notFoundMiddleware);
 

packages/core/src/server/getDevMiddlewares.ts

@@ -1,6 +1,7 @@
 import url from 'url';
 import type {
   ServerAPIs,
+  Middlewares,
   UpgradeEvent,
   RequestHandler,
   DevMiddlewaresConfig,
@@ -56,7 +57,7 @@ const applyDefaultMiddlewares = async ({
 }: {
   output: RsbuildDevMiddlewareOptions['output'];
   pwd: RsbuildDevMiddlewareOptions['pwd'];
-  middlewares: RequestHandler[];
+  middlewares: Middlewares;
   dev: RsbuildDevMiddlewareOptions['dev'];
   compileMiddlewareAPI?: CompileMiddlewareAPI;
 }): Promise<{
@@ -106,6 +107,11 @@ const applyDefaultMiddlewares = async ({
     });
   }
 
+  const { default: launchEditorMiddleware } = await import(
+    '../../compiled/launch-editor-middleware'
+  );
+  middlewares.push(['/__open-in-editor', launchEditorMiddleware()]);
+
   if (compileMiddlewareAPI) {
     middlewares.push(compileMiddlewareAPI.middleware);
 
@@ -164,7 +170,7 @@ const applyDefaultMiddlewares = async ({
 };
 
 export const getMiddlewares = async (options: RsbuildDevMiddlewareOptions) => {
-  const middlewares: RequestHandler[] = [];
+  const middlewares: Middlewares = [];
   const { compileMiddlewareAPI } = options;
 
   // Order: setupMiddlewares.unshift => internal middlewares => setupMiddlewares.push

packages/shared/src/types/server.ts

@@ -90,6 +90,8 @@ export type CompileMiddlewareAPI = {
   close: () => void;
 };
 
+export type Middlewares = Array<RequestHandler | [string, RequestHandler]>;
+
 export type DevServerAPIs = {
   /**
    * The resolved rsbuild server config
@@ -131,7 +133,7 @@ export type DevServerAPIs = {
      */
     overrides?: DevMiddlewaresConfig;
   }) => Promise<{
-    middlewares: RequestHandler[];
+    middlewares: Middlewares;
     close: () => Promise<void>;
     /**
      * Subscribe http upgrade event