fix: Update eslint dependencies and rules

Added the eslint's global variable registry and refactored the existing dependencies from a specific package of eslint-check into a global config file. Each eslint plugin now determines the rules by referring to the global config instead of their own. This removes the possibility of different eslint plugins having its own version of the same package and alleviates the concern on duplicated and conflicting packages, providing consistency through out the application and avoiding possible bugs. Additionally, updated eslint rules to enable better code checking and control of code quality.

Signed-off-by: prisis <[email protected]>

Author: prisis

.eslintignore

@@ -6,5 +6,6 @@ packages/babel-preset/babel.config.js
 packages/babel-preset/fixture/test.js
 packages/babel-preset/fixture/test.ts
 packages/stylelint-config/.stylelintrc.js
+packages/lint-staged-config/.lintstagedrc.js
 
 tsup.config.ts

.eslintrc.cjs renamed to .eslintrc.js

@@ -9,6 +9,7 @@
 name: "Dependency Review"
 
 on: # yamllint disable-line rule:truthy
+    # eslint-disable-next-line yml/no-empty-mapping-value
     pull_request: # yamllint disable-line rule:empty-values
 
 permissions:

.github/workflows/dependency-review.yml

@@ -6,6 +6,7 @@ on: # yamllint disable-line rule:truthy
     push:
         branches:
             - "main"
+    # eslint-disable-next-line yml/no-empty-mapping-value
     pull_request: # yamllint disable-line rule:empty-values
 
 concurrency:

.github/workflows/lint.yml

@@ -7,6 +7,7 @@ name: "Scorecard supply-chain security"
 on: # yamllint disable-line rule:truthy
     # For Branch-Protection check. Only the default branch is supported. See
     # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+    # eslint-disable-next-line yml/no-empty-mapping-value
     branch_protection_rule: # yamllint disable-line rule:empty-values
     # To guarantee Maintained check is occasionally updated. See
     # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained

.github/workflows/scorecards.yml

@@ -26,7 +26,8 @@ jobs:
               with:
                   repo-token: "${{ secrets.GITHUB_TOKEN }}"
                   stale-issue-message: |
-                      This issue has been automatically marked as stale because it has been open for 21 days with no activity. It will be closed in 7 days if no further activity (Remove label or comment) occurs.
+                      This issue has been automatically marked as stale because it has been open for 21 days with no activity.
+                      It will be closed in 7 days if no further activity (Remove label or comment) occurs.
                       If we missed this issue please reply to keep it active.
                       Thanks for being a part of this project. 🙏
                   stale-issue-label: "Stale"

.github/workflows/stale-issues.yml

@@ -6,6 +6,7 @@ on: # yamllint disable-line rule:truthy
     push:
         branches:
             - "main"
+    # eslint-disable-next-line yml/no-empty-mapping-value
     pull_request: # yamllint disable-line rule:empty-values
 
 concurrency:

.github/workflows/test.yml

@@ -163,6 +163,7 @@
         "eslint-find-rules": "^4.1.0",
         "eslint-plugin-babel": "^5.3.1",
         "eslint-plugin-cypress": "^2.13.3",
+        "eslint-plugin-etc": "^2.0.3",
         "eslint-plugin-jest": "^27.2.2",
         "eslint-plugin-jest-async": "^1.0.3",
         "eslint-plugin-jest-dom": "^5.0.1",
@@ -176,7 +177,6 @@
         "eslint-plugin-react-redux": "^4.0.0",
         "eslint-plugin-storybook": "^0.6.12",
         "eslint-plugin-tailwindcss": "^3.12.1",
-        "eslint-plugin-etc": "^2.0.3",
         "eslint-plugin-testing-library": "^5.11.0",
         "eslint-plugin-vitest": "^0.2.6",
         "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
@@ -192,6 +192,7 @@
         "eslint": "^8.15.0"
     },
     "optionalDependencies": {
+        "@tanstack/eslint-plugin-query": "^4.29.9",
         "eslint-plugin-array-func": "^3.1.8",
         "eslint-plugin-ava": "^14.0.0",
         "eslint-plugin-babel": "^5.3.1",
@@ -200,13 +201,12 @@
         "eslint-plugin-jest-async": "^1.0.3",
         "eslint-plugin-jest-dom": "^5.0.1",
         "eslint-plugin-jest-formatting": "^3.1.0",
-        "eslint-plugin-playwright": "^0.15.1",
         "eslint-plugin-jsdoc": "^46.3.0",
         "eslint-plugin-jsx-a11y": "^6.7.1",
         "eslint-plugin-n": "^16.0.1",
         "eslint-plugin-no-unsanitized": "^4.0.2",
+        "eslint-plugin-playwright": "^0.15.1",
         "eslint-plugin-prefer-object-spread": "^1.2.1",
-        "@tanstack/eslint-plugin-query": "^4.29.9",
         "eslint-plugin-react": "^7.32.2",
         "eslint-plugin-react-hooks": "^4.6.0",
         "eslint-plugin-react-redux": "^4.0.0",

packages/eslint-config/package.json

@@ -1,6 +1,7 @@
-import { hasDependency, hasDevDependency, pkg } from "@anolilab/package-json-utils";
+import { hasDependency, hasDevDependency } from "@anolilab/package-json-utils";
 
 import type { PackageRules } from "./types";
+import anolilabEslintConfig from "./utils/eslint-config";
 
 const baseConfig = ["best-practices", "errors", "style", "es6", "variables"];
 
@@ -93,7 +94,7 @@ const pluginConfig: PackageRules = [
     },
     {
         configName: "cypress",
-        dependencies: ["eslint-plugin-cypress"],
+        dependencies: ["cypress", "eslint-plugin-cypress"],
     },
     {
         configName: "jest",
@@ -164,17 +165,10 @@ const pluginConfig: PackageRules = [
 const loadedPlugins: string[] = [...internalPluginConfig];
 const possiblePlugins: { [rule: string]: { [packageName: string]: boolean } } = {};
 
-let anolilabEslintConfig: { [key: string]: { [key: string]: false | undefined } } = {};
-
-if (pkg) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access
-    anolilabEslintConfig = pkg?.["anolilab"]?.["eslint-config"];
-}
-
 pluginConfig.forEach((plugin) => {
     const { dependencies, configName } = plugin;
 
-    if (anolilabEslintConfig?.["plugin"]?.[configName] !== false) {
+    if ((anolilabEslintConfig as unknown as { [key: string]: { [key: string]: false | undefined } })?.["plugin"]?.[configName] !== false) {
         const foundDependencies = [];
 
         dependencies.forEach((dependency) => {

packages/eslint-config/src/config.ts

@@ -1,4 +1,4 @@
-import { hasAnyDep } from "@anolilab/package-json-utils";
+import { hasDependency, hasDevDependency } from "@anolilab/package-json-utils";
 import type { Linter } from "eslint";
 
 import { createConfig } from "../../utils/create-config";
@@ -10,14 +10,8 @@ const bestPracticesRules = bestPracticesConfig.rules as Linter.RulesRecord;
 const errorsRules = errorsConfig.rules as Linter.RulesRecord;
 const styleRules = styleConfig.rules as Linter.RulesRecord;
 
-let prettierRules: Linter.RulesRecord = {};
-
-if (
-    hasAnyDep(["prettier"], {
-        peerDeps: false,
-    })
-) {
-    prettierRules = {
+if (global.anolilabEslintConfigBabelPrettierRules === undefined && (hasDependency("prettier") || hasDevDependency("prettier"))) {
+    global.anolilabEslintConfigBabelPrettierRules = {
         "babel/quotes": 0,
 
         "@babel/object-curly-spacing": "off",
@@ -56,7 +50,7 @@ const config: Linter.Config = createConfig("all", {
         "valid-typeof": "off",
         "babel/valid-typeof": errorsRules["valid-typeof"],
 
-        ...prettierRules,
+        ...global.anolilabEslintConfigBabelPrettierRules,
     },
 });
 

packages/eslint-config/src/config/plugins/babel.ts

@@ -1,4 +1,4 @@
-import { hasAnyDep } from "@anolilab/package-json-utils";
+import { hasDependency, hasDevDependency } from "@anolilab/package-json-utils";
 import type { Linter } from "eslint";
 
 import styleConfig from "../style";
@@ -9,11 +9,7 @@ let hasPrettier = false;
 
 let prettierRules: Linter.RulesRecord = {};
 
-if (
-    hasAnyDep(["prettier"], {
-        peerDeps: false,
-    })
-) {
+if (hasDependency("prettier") || hasDevDependency("prettier")) {
     hasPrettier = true;
 
     prettierRules = {