Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate eslint config package #10174

Merged
merged 1 commit into from
Oct 29, 2024
+15 −0
Merged

Deprecate eslint config package #10174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/giant-eggs-march.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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