Skip to content

Commit

Permalink
Deprecate eslint config package (#10174)
Browse files Browse the repository at this point in the history
  • Loading branch information
brophdawg11 authored Oct 29, 2024
1 parent f9764f7 commit 152eb87
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/giant-eggs-march.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@remix-run/eslint-config": minor
---

Add deprecation warning to `@remix-run/eslint-config`
3 changes: 3 additions & 0 deletions packages/remix-eslint-config/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions packages/remix-eslint-config/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 152eb87

Please sign in to comment.