feat(compiler): Add support for remix config feature flags

.changeset/calm-eels-invite.md

@@ -0,0 +1,5 @@
+---
+"@remix-run/dev": patch
+---
+
+Added support for feature flags in `remix.config.js`

packages/remix-dev/__tests__/readConfig-test.ts

@@ -22,6 +22,9 @@ describe("readConfig", () => {
         assetsBuildDirectory: expect.any(String),
         relativeAssetsBuildDirectory: expect.any(String),
         tsconfigPath: expect.any(String),
+        features: {
+          v2_meta: expect.any(Boolean),
+        },
       },
       `
       Object {
@@ -32,6 +35,9 @@ describe("readConfig", () => {
         "devServerPort": Any<Number>,
         "entryClientFile": "entry.client.tsx",
         "entryServerFile": "entry.server.tsx",
+        "features": Object {
+          "v2_meta": Any<Boolean>,
+        },
         "mdx": undefined,
         "publicPath": "/build/",
         "relativeAssetsBuildDirectory": Any<String>,

packages/remix-dev/compiler/plugins/serverEntryModulePlugin.ts

@@ -45,6 +45,7 @@ ${Object.keys(config.routes)
   export const assetsBuildDirectory = ${JSON.stringify(
     config.relativeAssetsBuildDirectory
   )};
+  export const features = ${JSON.stringify(config.features)};
   export const publicPath = ${JSON.stringify(config.publicPath)};
   export const entry = { module: entryServer };
   export const routes = {

packages/remix-dev/config.ts

@@ -157,6 +157,8 @@ export interface AppConfig {
     | string
     | string[]
     | (() => Promise<string | string[]> | string | string[]);
+
+  features?: { [key: string]: unknown }; // TODO: This type will change when we start adding features
 }
 
 /**
@@ -275,6 +277,8 @@ export interface RemixConfig {
    * The path for the tsconfig file, if present on the root directory.
    */
   tsconfigPath: string | undefined;
+
+  features: { [key: string]: unknown }; // TODO: This type will change when we start adding features
 }
 
 /**
@@ -472,6 +476,10 @@ export async function readConfig(
     writeConfigDefaults(tsconfigPath);
   }
 
+  let features = {
+    v2_meta: appConfig.features?.v2_meta === true,
+  };
+
   return {
     appDirectory,
     cacheDirectory,
@@ -495,6 +503,7 @@ export async function readConfig(
     mdx,
     watchPaths,
     tsconfigPath,
+    features,
   };
 }
 

packages/remix-dev/index.ts

@@ -1,6 +1,6 @@
 import "./modules";
 
-export type { AppConfig } from "./config";
+export type { AppConfig, RemixConfig as ResolvedRemixConfig } from "./config";
 
 export * as cli from "./cli/index";
 export { createApp } from "./cli/create";

packages/remix-react/components.tsx

@@ -71,6 +71,9 @@ interface RemixEntryContextType {
   serverHandoffString?: string;
   clientRoutes: ClientRoute[];
   transitionManager: ReturnType<typeof createTransitionManager>;
+  features: {
+    v2_meta: boolean;
+  };
 }
 
 export const RemixEntryContext = React.createContext<
@@ -195,6 +198,7 @@ export function RemixEntry({
         routeData: loaderData,
         actionData,
         transitionManager,
+        features: entryContext.features,
       }}
     >
       <RemixErrorBoundary

packages/remix-react/entry.ts

@@ -12,6 +12,9 @@ export interface EntryContext {
   actionData?: RouteData;
   routeModules: RouteModules;
   serverHandoffString?: string;
+  features: {
+    v2_meta: boolean;
+  };
 }
 
 export interface AssetsManifest {

packages/remix-server-runtime/build.ts

@@ -13,6 +13,9 @@ export interface ServerBuild {
   assets: AssetsManifest;
   publicPath: string;
   assetsBuildDirectory: string;
+  features: {
+    v2_meta: boolean;
+  };
 }
 
 export interface HandleDocumentRequestFunction {

packages/remix-server-runtime/entry.ts

@@ -17,6 +17,9 @@ export interface EntryContext {
   actionData?: RouteData;
   routeModules: RouteModules<EntryRouteModule>;
   serverHandoffString?: string;
+  features: {
+    v2_meta: boolean;
+  };
 }
 
 export interface AssetsManifest {

packages/remix-server-runtime/server.ts

@@ -577,6 +577,7 @@ async function handleDocumentRequest({
     appState: appState,
     matches: entryMatches,
     routeData,
+    features: build.features,
   };
 
   let entryContext: EntryContext = {