Add deprecation warning for v2_meta (#5878)

remix-run · Mar 23, 2023 · e4c93b3 · e4c93b3
1 parent 5b4674c
commit e4c93b3
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/.changeset/meta-deprecation-warning.md b/.changeset/meta-deprecation-warning.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/dev": patch
+---
+
+Add deprecation warning for `future.v2_meta`
diff --git a/integration/hmr-test.ts b/integration/hmr-test.ts
@@ -18,6 +18,7 @@ let fixture = (options: { port: number; appServerPort: number }) => ({
     v2_routeConvention: true,
     v2_errorBoundary: true,
     v2_normalizeFormMethod: true,
+    v2_meta: true,
   },
   files: {
     "package.json": json({

diff --git a/packages/remix-dev/__tests__/create-test.ts b/packages/remix-dev/__tests__/create-test.ts
@@ -12,6 +12,7 @@ import {
   errorBoundaryWarning,
   flatRoutesWarning,
   formMethodWarning,
+  metaWarning,
 } from "../config";
 
 beforeAll(() => server.listen({ onUnhandledRequest: "error" }));
@@ -356,6 +357,8 @@ describe("the create command", () => {
         "\n" +
         formMethodWarning +
         "\n" +
+        metaWarning +
+        "\n" +
         flatRoutesWarning +
         "\n\n" +
         getOptOutOfInstallMessage() +

diff --git a/packages/remix-dev/config.ts b/packages/remix-dev/config.ts
@@ -415,6 +415,10 @@ export async function readConfig(
     warnOnce(formMethodWarning, "v2_normalizeFormMethod");
   }
 
+  if (!appConfig.future?.v2_meta) {
+    warnOnce(metaWarning, "v2_meta");
+  }
+
   let isCloudflareRuntime = ["cloudflare-pages", "cloudflare-workers"].includes(
     appConfig.serverBuildTarget ?? ""
   );
@@ -852,3 +856,8 @@ export const formMethodWarning =
   "prepare for the Remix v2 release. Lowercase `useNavigation().formMethod`" +
   "values are being normalized to uppercase in v2 to align with the `fetch()` " +
   "behavior.  For more information, see https://remix.run/docs/hooks/use-navigation";
+
+export const metaWarning =
+  "⚠️  DEPRECATED: Please enable the `future.v2_meta` flag to " +
+  "prepare for the Remix v2 release. For more information, see " +
+  "https://remix.run/docs/route/meta#md-metav2.";