feat(remix-eslint-config): add deprecation warning to `@remix-run/esl…

…int-config/jest` ESLint config
remix-run · Mar 8, 2023 · a08ba2b · a08ba2b
1 parent 96813db
commit a08ba2b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/.changeset/wicked-hairs-tell.md b/.changeset/wicked-hairs-tell.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/eslint-config": minor
+---
+
+add deprecation warning to `@remix-run/eslint-config/jest` ESLint config
diff --git a/packages/remix-eslint-config/jest.js b/packages/remix-eslint-config/jest.js
@@ -6,6 +6,23 @@ const jestRules = require("./rules/jest");
  */
 require("@rushstack/eslint-patch/modern-module-resolution");
 
+const alreadyWarned = {};
+const warnOnce = (condition, message) => {
+  if (!condition && !alreadyWarned[message]) {
+    alreadyWarned[message] = true;
+    console.warn(message);
+  }
+};
+
+warnOnce(
+  false,
+  "⚠️ DEPRECATED: The `@remix-run/eslint-config/jest` ESLint config " +
+    "has been deprecated in favor of " +
+    "`@remix-run/eslint-config/jest-testing-library` and will be removed in " +
+    "Remix v2. Please update your code to use " +
+    "`@remix-run/eslint-config/jest-testing-library` instead."
+);
+
 /**
  * @deprecated Use `@remix-run/eslint-config/jest-testing-library` instead.
  */