Add eslint-plugin-perfectionist and eslint-plugin-react-perf to t…

…he base and `/react` configs, respectively (#20)
babbel · Sep 18, 2024 · 190a48d · 190a48d
1 parent 7d7c647
commit 190a48d
Show file tree

Hide file tree

Showing 13 changed files with 94 additions and 48 deletions.
diff --git a/.github/workflows/publishWorkflow.yml b/.github/workflows/publishWorkflow.yml
@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: oven-sh/setup-bun@v2
         with:
-          bun-version: "1.1.17"
+          bun-version: "1.1.27"
       - uses: mangs/simple-release-notes-action@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/pullRequestWorkflow.yml b/.github/workflows/pullRequestWorkflow.yml
@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: oven-sh/setup-bun@v2
         with:
-          bun-version: "1.1.17"
+          bun-version: "1.1.27"
       - run: bun install --frozen-lockfile
       - run: bun run check:environment
       - run: bun --bun run check:formatting

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## 2.1.0
+
+- Add [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) to the base configuration and all its dependent configurations
+  - Provides more robust and consistent alphabetical sorting features than what ESLint provides by default
+  - All rules are auto-fixable
+  - Its rules replace rules `import/order`, `sort-keys`, and `sort-vars`
+- Add [`eslint-plugin-react-perf`](https://github.com/cvazac/eslint-plugin-react-perf) to the `/react` configuration and all its dependent configurations
+  - Provides performance-related checks to prevent code that causes performance problems
+- Upgrade dependencies to latest versions
+- Upgrade Bun version from `1.1.17` to `1.1.27`
+
 ## 2.0.3
 
 - Upgrade dependencies to latest versions

diff --git a/bun.lockb b/bun.lockb
diff --git a/lib/eslintBaseConfig.json b/lib/eslintBaseConfig.json
@@ -2,13 +2,15 @@
   "plugins": [
     "eslint-plugin-eslint-comments",
     "eslint-plugin-import",
+    "eslint-plugin-perfectionist",
     "eslint-plugin-regexp",
     "eslint-plugin-unicorn"
   ],
   "extends": [
     "eslint-config-airbnb-base",
     "plugin:eslint-comments/recommended",
     "plugin:import/recommended",
+    "plugin:perfectionist/recommended-alphabetical-legacy",
     "plugin:regexp/recommended",
     "plugin:unicorn/recommended"
   ],
@@ -33,25 +35,36 @@
     "import/group-exports": "error",
     "import/no-default-export": "error",
     "import/no-unresolved": ["error", { "caseSensitiveStrict": true }],
-    "import/order": [
+    "import/order": "off",
+    "import/prefer-default-export": "off",
+    "no-console": "error",
+    "no-restricted-syntax": "off",
+    "no-use-before-define": ["error", { "functions": false }],
+    "perfectionist/sort-imports": [
       "error",
       {
+        "environment": "node",
         "groups": [
+          ["side-effect", "side-effect-style"],
           ["builtin", "external"],
           ["index", "internal", "parent", "sibling", "unknown"],
-          ["type"],
-          ["object"]
-        ],
-        "newlines-between": "always"
+          "object",
+          [
+            "builtin-type",
+            "external-type",
+            "index-type",
+            "internal-type",
+            "parent-type",
+            "sibling-type",
+            "type"
+          ],
+          "style"
+        ]
       }
     ],
-    "import/prefer-default-export": "off",
-    "no-console": "error",
-    "no-restricted-syntax": "off",
-    "no-use-before-define": ["error", { "functions": false }],
+    "perfectionist/sort-named-exports": ["error", { "groupKind": "values-first" }],
+    "perfectionist/sort-named-imports": ["error", { "groupKind": "values-first" }],
     "require-await": "error",
-    "sort-keys": "error",
-    "sort-vars": "error",
     "unicorn/filename-case": ["error", { "case": "camelCase" }],
     "unicorn/numeric-separators-style": ["error", { "number": { "minimumDigits": 0 } }],
     "unicorn/relative-url-style": ["error", "always"],

diff --git a/lib/eslintBunConfig.json b/lib/eslintBunConfig.json
@@ -3,12 +3,31 @@
   "globals": {
     "Bun": "readonly"
   },
-  "settings": {
-    "import/core-modules": ["bun", "bun:jsc", "bun:sql", "bun:sqlite", "bun:test"]
-  },
   "rules": {
     "n/no-unsupported-features/es-builtins": "off",
     "n/no-unsupported-features/es-syntax": "off",
-    "n/no-unsupported-features/node-builtins": "off"
+    "n/no-unsupported-features/node-builtins": "off",
+    "perfectionist/sort-imports": [
+      "error",
+      {
+        "environment": "bun",
+        "groups": [
+          ["side-effect", "side-effect-style"],
+          ["builtin", "external"],
+          ["index", "internal", "parent", "sibling", "unknown"],
+          "object",
+          [
+            "builtin-type",
+            "external-type",
+            "index-type",
+            "internal-type",
+            "parent-type",
+            "sibling-type",
+            "type"
+          ],
+          "style"
+        ]
+      }
+    ]
   }
 }
diff --git a/lib/eslintReactConfig.json b/lib/eslintReactConfig.json
@@ -1,9 +1,10 @@
 {
-  "plugins": ["eslint-plugin-jsx-a11y"],
+  "plugins": ["eslint-plugin-jsx-a11y", "eslint-plugin-react-perf"],
   "extends": [
     "eslint-config-airbnb",
     "airbnb/hooks",
     "plugin:jsx-a11y/recommended",
+    "plugin:react-perf/recommended",
     "./eslintBaseConfig.json"
   ],
   "env": {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@babbel/eslint-config",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "author": "Eric L. Goldstein <egoldstein@babbel.com>",
   "description": "Hierarchical ESLint configuration collection that intends to be simple to use, layered, and shared with others",
   "keywords": [
@@ -10,7 +10,7 @@
   "engines": {
     "node": "^18.18.0 || >=20.0.0"
   },
-  "packageManager": "bun@1.1.17",
+  "packageManager": "bun@1.1.27",
   "exports": {
     ".": "./lib/eslintBaseConfig.json",
     "./browser": "./lib/eslintBrowserConfig.json",
@@ -53,30 +53,32 @@
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-airbnb-typescript": "18.0.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-compat": "6.0.0",
+    "eslint-plugin-compat": "6.0.1",
     "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jest": "28.7.0",
+    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-jest": "28.8.3",
     "eslint-plugin-jest-dom": "5.4.0",
     "eslint-plugin-jest-formatting": "3.1.0",
-    "eslint-plugin-jsdoc": "50.0.0",
-    "eslint-plugin-jsx-a11y": "6.9.0",
+    "eslint-plugin-jsdoc": "50.2.3",
+    "eslint-plugin-jsx-a11y": "6.10.0",
     "eslint-plugin-n": "17.10.2",
+    "eslint-plugin-perfectionist": "3.6.0",
     "eslint-plugin-playwright": "1.6.2",
+    "eslint-plugin-react-perf": "3.3.2",
     "eslint-plugin-regexp": "2.6.0",
     "eslint-plugin-security": "3.0.1",
     "eslint-plugin-unicorn": "55.0.0"
   },
   "devDependencies": {
-    "@mangs/bun-utils": "2.30.1",
-    "@playwright/test": "1.46.0",
-    "@types/aws-lambda": "8.10.143",
-    "@types/node": "22.1.0",
-    "@types/react": "18.3.3",
+    "@mangs/bun-utils": "2.32.0",
+    "@playwright/test": "1.47.1",
+    "@types/aws-lambda": "8.10.145",
+    "@types/node": "22.5.5",
+    "@types/react": "18.3.6",
     "@types/react-dom": "18.3.0",
-    "eslint": "8.57.0",
+    "eslint": "8.57.1",
     "jest": "29.7.0",
-    "preact": "10.23.1",
+    "preact": "10.24.0",
     "prettier": "3.3.3",
     "prop-types": "15.8.1",
     "react": "18.3.1",

diff --git a/test/eslintBaseConfig/exampleBaseConfigEntrypoint.mjs b/test/eslintBaseConfig/exampleBaseConfigEntrypoint.mjs
@@ -192,26 +192,26 @@ export {
   anError,
   buffer,
   checkRegexRuleNoMissingGFlag,
-  checkUnicornRulePreferObjectFromEntries,
-  checkUnicornRuleRequireArrayJoinSeparator,
-  checkUnicornRulePreferStringStartsEndsWith,
-  checkUnicornRulePreferTypeError,
   checkRegexRuleNoUselessDollarReplacements,
-  checkUnicornRulePreferOptionalCatchBinding,
-  checkUnicornRulePreferSetHas,
-  checkUnicornRulePreferSpread,
   checkUnicornRuleExplicitLengthCheck,
-  checkUnicornRulePreferTernary,
-  checkUnicornRulePreferStringTrimStartEnd,
-  checkUnicornRulePreferRegexpTest,
-  checkUnicornRulePreferSwitch,
   checkUnicornRulePreferArrayFind,
   checkUnicornRulePreferArrayFlat,
-  checkUnicornRulePreferReflectApply,
   checkUnicornRulePreferArrayFlatMap,
   checkUnicornRulePreferAt,
   checkUnicornRulePreferBlobReadingMethods,
   checkUnicornRulePreferIncludes,
+  checkUnicornRulePreferObjectFromEntries,
+  checkUnicornRulePreferOptionalCatchBinding,
+  checkUnicornRulePreferReflectApply,
+  checkUnicornRulePreferRegexpTest,
+  checkUnicornRulePreferSetHas,
+  checkUnicornRulePreferSpread,
+  checkUnicornRulePreferStringStartsEndsWith,
+  checkUnicornRulePreferStringTrimStartEnd,
+  checkUnicornRulePreferSwitch,
+  checkUnicornRulePreferTernary,
+  checkUnicornRulePreferTypeError,
+  checkUnicornRuleRequireArrayJoinSeparator,
   escapeSequence,
   eventTarget,
   fortyTwo,

diff --git a/test/eslintReactConfig/exampleReactConfigEntrypoint.jsx b/test/eslintReactConfig/exampleReactConfigEntrypoint.jsx
@@ -1,8 +1,8 @@
 // Code based on this example: https://react.dev/learn/tutorial-tic-tac-toe#what-are-you-building
 
 // External Imports
-import { createRoot } from 'react-dom/client';
 import React from 'react';
+import { createRoot } from 'react-dom/client';
 
 // Internal Imports
 import { Game } from './components/Game.jsx';

diff --git a/test/eslintReactTypescriptConfig/exampleReactTypescriptConfigEntrypoint.tsx b/test/eslintReactTypescriptConfig/exampleReactTypescriptConfigEntrypoint.tsx
@@ -1,8 +1,8 @@
 // Code based on this example: https://react.dev/learn/tutorial-tic-tac-toe#what-are-you-building
 
 // External Imports
-import { createRoot } from 'react-dom/client';
 import React from 'react';
+import { createRoot } from 'react-dom/client';
 
 // Internal Imports
 import { Game } from './components/Game.tsx';

diff --git a/test/eslintTypescriptConfig/exampleTypescriptConfigEntrypoint.ts b/test/eslintTypescriptConfig/exampleTypescriptConfigEntrypoint.ts
@@ -1,8 +1,8 @@
 // Internal Imports
 import {
+  alternateRoute,
   buildUncachedResponse,
   defaultRoute,
-  alternateRoute,
 } from './exampleTypescriptConfigImport.ts';
 
 // Type Imports

diff --git a/test/eslintTypescriptConfig/exampleTypescriptConfigImport.ts b/test/eslintTypescriptConfig/exampleTypescriptConfigImport.ts
@@ -24,4 +24,4 @@ function alternateRoute(apiGatewayEvent: APIGatewayProxyEvent): APIGatewayProxyS
 }
 
 // Module Exports
-export { buildUncachedResponse, defaultRoute, alternateRoute };
+export { alternateRoute, buildUncachedResponse, defaultRoute };