From b201e3e0b71ac3f2021def72edd3d1d349725f3b Mon Sep 17 00:00:00 2001
From: Matt Brophy <matt@brophy.org>
Date: Tue, 29 Oct 2024 10:28:58 -0400
Subject: [PATCH] Deprecate eslint config package

---
 .changeset/giant-eggs-march.md         | 5 +++++
 packages/remix-eslint-config/README.md | 3 +++
 packages/remix-eslint-config/index.js  | 7 +++++++
 3 files changed, 15 insertions(+)
 create mode 100644 .changeset/giant-eggs-march.md

diff --git a/.changeset/giant-eggs-march.md b/.changeset/giant-eggs-march.md
new file mode 100644
index 00000000000..d68d180a949
--- /dev/null
+++ b/.changeset/giant-eggs-march.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/eslint-config": minor
+---
+
+Add deprecation warning to `@remix-run/eslint-config`
diff --git a/packages/remix-eslint-config/README.md b/packages/remix-eslint-config/README.md
index 80d768806a4..9aad1204887 100644
--- a/packages/remix-eslint-config/README.md
+++ b/packages/remix-eslint-config/README.md
@@ -1,5 +1,8 @@
 # `@remix-run/eslint-config`
 
+> [!WARNING]
+> The `@remix-run/eslint-config` package is deprecated and will not be included in React Router v7. We recommend moving towards a streamlined ESLint config such as the ones included in the Remix templates. See https://github.com/remix-run/remix/blob/main/templates/remix/.eslintrc.cjs.
+
 This package includes a shareable ESLint config for Remix projects.
 
 If you create your app with `create-remix` no additional configuration is necessary.
diff --git a/packages/remix-eslint-config/index.js b/packages/remix-eslint-config/index.js
index 2b5ec34853d..740160fd02d 100644
--- a/packages/remix-eslint-config/index.js
+++ b/packages/remix-eslint-config/index.js
@@ -14,6 +14,13 @@ const reactSettings = require("./settings/react");
  */
 require("@rushstack/eslint-patch/modern-module-resolution");
 
+console.warn(
+  "⚠️ REMIX FUTURE CHANGE: The `@remix-run/eslint-config` package is deprecated " +
+    "and will not be included in React Router v7.  We recommend moving towards a " +
+    "streamlined ESLint config such as the ones included in the Remix templates. " +
+    "See https://github.com/remix-run/remix/blob/main/templates/remix/.eslintrc.cjs."
+);
+
 const OFF = 0;
 // const WARN = 1;
 // const ERROR = 2;