feat: opt-in filesystem routing using serverDir config (#3719)

Author: pi0

playground/src/entry-server.ts renamed to playground/app/entry-server.ts

@@ -5,4 +5,10 @@ import tailwindcss from "@tailwindcss/vite";
 
 export default defineConfig({
   plugins: [nitro(), tailwindcss()],
+  nitro: {
+    // serverDir: "server",
+    routes: {
+      "/quote": { handler: "./server/routes/quote.ts" },
+    },
+  },
 });

playground/routes/quote.ts renamed to playground/server/routes/quote.ts

@@ -36,18 +36,18 @@ export async function copyPublicAssets(nitro: Nitro) {
     return;
   }
   for (const asset of nitro.options.publicAssets) {
-    const srcDir = asset.dir;
+    const assetDir = asset.dir;
     const dstDir = join(nitro.options.output.publicDir, asset.baseURL!);
-    if (await isDirectory(srcDir)) {
-      const includePatterns = getIncludePatterns(nitro, srcDir);
+    if (await isDirectory(assetDir)) {
+      const includePatterns = getIncludePatterns(nitro, assetDir);
       const publicAssets = await glob(includePatterns, {
-        cwd: srcDir,
+        cwd: assetDir,
         absolute: false,
         dot: true,
       });
       await Promise.all(
         publicAssets.map(async (file) => {
-          const src = join(srcDir, file);
+          const src = join(assetDir, file);
           const dst = join(dstDir, file);
           if (!existsSync(dst)) {
             await fsp.cp(src, dst);
@@ -64,7 +64,7 @@ export async function copyPublicAssets(nitro: Nitro) {
   );
 }
 
-function getIncludePatterns(nitro: Nitro, srcDir: string) {
+function getIncludePatterns(nitro: Nitro, assetDir: string) {
   return [
     "**",
     ...nitro.options.ignore.map((p) => {
@@ -75,7 +75,7 @@ function getIncludePatterns(nitro: Nitro, srcDir: string) {
         // Make non-glob patterns relative to publicAssetDir
         (pattern.startsWith("*")
           ? pattern
-          : relative(srcDir, resolve(nitro.options.srcDir, pattern)))
+          : relative(assetDir, resolve(nitro.options.rootDir, pattern)))
       );
     }),
   ].filter((p) => !PARENT_DIR_GLOB_RE.test(p));

playground/vite.config.mjs

@@ -131,7 +131,7 @@ export function baseBuildPlugins(nitro: Nitro, base: BaseBuildConfig) {
               ? [(id: string) => id?.endsWith(".wasm")]
               : []),
             runtimeDir,
-            nitro.options.srcDir,
+            nitro.options.serverDir,
             ...nitro.options.handlers
               .map((m) => m.handler)
               .filter((i) => typeof i === "string"),
@@ -140,7 +140,7 @@ export function baseBuildPlugins(nitro: Nitro, base: BaseBuildConfig) {
             nitro.options.experimental.bundleRuntimeDependencies === false
               ? []
               : runtimeDependencies),
-          ],
+          ].filter(Boolean) as string[],
           traceOptions: {
             base: "/",
             processCwd: nitro.options.rootDir,

src/build/assets.ts

@@ -41,8 +41,8 @@ export async function watchDev(nitro: Nitro, config: RolldownOptions) {
     }
   });
 
-  const srcDirWatcher = watch(
-    nitro.options.srcDir,
+  const rootDirWatcher = watch(
+    nitro.options.rootDir,
     { persistent: false },
     (_event, filename) => {
       if (filename && /^server\.[mc]?[jt]sx?$/.test(filename)) {
@@ -54,7 +54,7 @@ export async function watchDev(nitro: Nitro, config: RolldownOptions) {
   nitro.hooks.hook("close", () => {
     watcher.close();
     scanDirsWatcher.close();
-    srcDirWatcher.close();
+    rootDirWatcher.close();
   });
 
   nitro.hooks.hook("rollup:reload", () => reload());

src/build/plugins.ts

@@ -43,8 +43,8 @@ export async function watchDev(nitro: Nitro, rollupConfig: RollupConfig) {
     }
   });
 
-  const srcDirWatcher = watch(
-    nitro.options.srcDir,
+  const rootDirWatcher = watch(
+    nitro.options.rootDir,
     { persistent: false },
     (_event, filename) => {
       if (filename && /^server\.[mc]?[jt]sx?$/.test(filename)) {
@@ -56,7 +56,7 @@ export async function watchDev(nitro: Nitro, rollupConfig: RollupConfig) {
   nitro.hooks.hook("close", () => {
     rollupWatcher.close();
     scanDirsWatcher.close();
-    srcDirWatcher.close();
+    rootDirWatcher.close();
   });
 
   nitro.hooks.hook("rollup:reload", () => reload());

src/build/rolldown/dev.ts

@@ -241,9 +241,15 @@ export async function writeTypes(nitro: Nitro) {
           "./"
         ),
         join(relativeWithDot(tsconfigDir, nitro.options.rootDir), "**/*"),
-        ...(nitro.options.srcDir === nitro.options.rootDir
+        ...(!nitro.options.serverDir ||
+        nitro.options.serverDir === nitro.options.rootDir
           ? []
-          : [join(relativeWithDot(tsconfigDir, nitro.options.srcDir), "**/*")]),
+          : [
+              join(
+                relativeWithDot(tsconfigDir, nitro.options.serverDir),
+                "**/*"
+              ),
+            ]),
       ],
     });
 

src/build/rollup/dev.ts

@@ -147,8 +147,8 @@ export async function configureViteDevServer(
     }
   });
 
-  const srcDirWatcher = fsWatch(
-    nitro.options.srcDir,
+  const rootDirWatcher = fsWatch(
+    nitro.options.rootDir,
     { persistent: false },
     (_event, filename) => {
       if (filename && /^server\.[mc]?[jt]sx?$/.test(filename)) {
@@ -158,7 +158,7 @@ export async function configureViteDevServer(
   );
   nitro.hooks.hook("close", () => {
     scanDirsWatcher.close();
-    srcDirWatcher.close();
+    rootDirWatcher.close();
   });
 
   // Worker => Host IPC

src/build/types.ts

@@ -361,8 +361,10 @@ async function setupNitroContext(
     ctx.pluginConfig.services ??= {};
     if (userConfig.environments?.ssr === undefined) {
       const ssrEntry = resolveModulePath("./entry-server", {
-        from: ["", "app", "src"].flatMap((d) =>
-          ctx.nitro!.options.scanDirs.map((s) => join(s, d) + "/")
+        from: ["app", "src", ""].flatMap((d) =>
+          [ctx.nitro!.options.rootDir, ...ctx.nitro!.options.scanDirs].map(
+            (s) => join(s, d) + "/"
+          )
         ),
         extensions: DEFAULT_EXTENSIONS,
         try: true,
@@ -380,7 +382,7 @@ async function setupNitroContext(
       if (typeof ssrEntry === "string") {
         ssrEntry =
           resolveModulePath(ssrEntry, {
-            from: ctx.nitro.options.scanDirs,
+            from: [ctx.nitro.options.rootDir, ...ctx.nitro.options.scanDirs],
             extensions: DEFAULT_EXTENSIONS,
             suffixes: ["", "/index"],
             try: true,