feat: Modify jsMeta to metafile option (remix-run#6441)

19Qingfeng · May 24, 2023 · 9c48eed · 9c48eed
1 parent cc3059e
commit 9c48eed
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 14 deletions.
diff --git a/packages/remix-dev/compiler/utils/analyzer.ts b/packages/remix-dev/compiler/utils/analyzer.ts
@@ -1,15 +1,15 @@
-import { resolve } from 'path'
+import { resolve, normalize } from 'path'
 import fs from 'fs-extra'
 import type { Metafile } from 'esbuild';
 
 import type { Context } from "../context";
 import invariant from "../../invariant";
 
 
-const JS_META_FILE_NAME = 'remix-js-metafile.json';
+const JS_META_FILE_NAME = 'browser-metafile.json';
 
 
-const getMetaPath = (target: string, filename: string) => resolve(target, filename);
+const getMetaPath = (target: string, filename: string) => normalize(resolve(target, filename));
 
 /**
  * Generate metafile for esbuild analyze
@@ -20,17 +20,20 @@ const createMetaFile = (ctx: Context) => {
     config
   } = ctx;
   let {
-    browserMeta,
-    assetsBuildDirectory
+    metafile,
+    debugDirectory
   } = config
   return {
     createBrowserMetaFile: (outputMeta?: Metafile) => {
-      if (browserMeta && outputMeta) {
+      if (metafile && outputMeta) {
         try {
-          let output = getMetaPath(assetsBuildDirectory, JS_META_FILE_NAME);
-          return fs.writeFile(output, JSON.stringify(outputMeta));
+          let output = getMetaPath(debugDirectory, JS_META_FILE_NAME);
+          if (!fs.existsSync(debugDirectory)) {
+            fs.mkdirSync(debugDirectory)
+          }
+          return fs.writeFile(normalize(output), JSON.stringify(outputMeta));
         } catch (e) {
-          invariant(e, `Failed to generate ${JS_META_FILE_NAME}.`);
+          invariant(e, `Failed to generate ${JS_META_FILE_NAME} in ${debugDirectory}.`);
         }
       }
     }

diff --git a/packages/remix-dev/config.ts b/packages/remix-dev/config.ts
@@ -91,10 +91,15 @@ export interface AppConfig {
    */
   assetsBuildDirectory?: string;
 
+  /**
+    * The path to the browser metafile build, relative to `remix.config.js`. Defaults  * to "public/.debug".
+  */
+  debugDirectory?: string
+
   /**
    * Whether to support generate browser js metafile for esbuild, default to false.
    */
-  browserMeta?: boolean;
+  metafile?: boolean;
 
   /**
    * The path to the browser build, relative to remix.config.js. Defaults to
@@ -273,11 +278,16 @@ export interface RemixConfig {
    */
   assetsBuildDirectory: string;
 
+  /**
+   * The absolute path to the metafile build directory.
+   */
+  debugDirectory: string
+
   /**
    * Whether to support generate browser js metafile for esbuild, default to false.
    * When you set it to true, remix-js-metafile.json will be generated in the assetsBuildDirectory directory.
    */
-  browserMeta?: boolean;
+  metafile?: boolean;
 
   /**
    * the original relative path to the assets build directory
@@ -658,8 +668,6 @@ export async function readConfig(
     ? path.resolve(appDirectory, userEntryServerFile)
     : path.resolve(defaultsDirectory, entryServerFile);
 
-  let browserMeta = !!appConfig.browserMeta
-
   if (appConfig.browserBuildDirectory) {
     warnOnce(browserBuildDirectoryWarning, "browserBuildDirectory");
   }
@@ -669,11 +677,20 @@ export async function readConfig(
     appConfig.browserBuildDirectory ||
     path.join("public", "build");
 
+
   let absoluteAssetsBuildDirectory = path.resolve(
     rootDirectory,
     assetsBuildDirectory
   );
 
+  let absoluteDebugDirectory = path.resolve(
+    rootDirectory,
+    appConfig.debugDirectory || path.join("public", ".debugger")
+  );
+
+  let metafile = !!appConfig.metafile
+
+
   let devServerPort =
     Number(process.env.REMIX_DEV_SERVER_WS_PORT) ||
     (await getPort({ port: Number(appConfig.devServerPort) || 8002 }));
@@ -762,7 +779,8 @@ export async function readConfig(
     entryClientFilePath,
     entryServerFile,
     entryServerFilePath,
-    browserMeta,
+    debugDirectory: absoluteDebugDirectory,
+    metafile,
     devServerPort,
     devServerBroadcastDelay,
     assetsBuildDirectory: absoluteAssetsBuildDirectory,