Skip to content

feat(common-config): Add autofix for sort-keys (resolves #17). #18

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(common-config): Add autofix for sort-keys (resolves #17). #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d37b574
Add auto fix for sort keys
zzxthehappiest May 8, 2025
b2f2b49
Fix comments
zzxthehappiest May 12, 2025
0d52398
Fix comment
zzxthehappiest May 12, 2025
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: 4 additions & 1 deletion CommonConfig.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import ImportNewlinesPlugin from "eslint-plugin-import-newlines";
import JsdocPlugin from "eslint-plugin-jsdoc";
import NoAutofixPlugin from "eslint-plugin-no-autofix";
import SimpleImportSortPlugin from "eslint-plugin-simple-import-sort";
import SortKeysPlusPlugin from "eslint-plugin-sort-keys-plus";
Copy link

@coderabbitai coderabbitai bot May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify plugin installation, lockfile, and documentation
Ensure that eslint-plugin-sort-keys-plus is declared in your package.json (dependencies or peerDependencies) and that you have committed the updated lockfile (package-lock.json or yarn.lock). Without this, ESLint will report a missing plugin error. Additionally, consider updating your README or other documentation to mention the new plugin and its configuration options.
You can verify installation with:

🏁 Script executed:

grep -R '"eslint-plugin-sort-keys-plus"' package.json

Length of output: 101

🏁 Script executed:

#!/bin/bash
echo "Checking package-lock.json:"
if [ -f package-lock.json ]; then
  grep -R "eslint-plugin-sort-keys-plus" package-lock.json
else
  echo "package-lock.json not found"
fi

echo "Checking yarn.lock:"
if [ -f yarn.lock ]; then
  grep -R "eslint-plugin-sort-keys-plus" yarn.lock
else
  echo "yarn.lock not found"
fi

Length of output: 492

🏁 Script executed:

#!/bin/bash
echo "Searching Markdown files for plugin mention:"
grep -R "eslint-plugin-sort-keys-plus" --include="*.md" .

Length of output: 156

Update documentation for eslint-plugin-sort-keys-plus
I’ve confirmed that eslint-plugin-sort-keys-plus is declared in your package.json and present in package-lock.json. However, I didn’t find any references in your Markdown documentation. Please update your README (or other docs) to mention the new plugin and provide its configuration options.

• File to update: README.md (or relevant docs) – add a section on ESLint plugins, include sort-keys-plus and its config.



const CommonConfig = {
Expand All @@ -18,6 +19,7 @@ const CommonConfig = {
"jsdoc": JsdocPlugin,
"no-autofix": NoAutofixPlugin,
"simple-import-sort": SimpleImportSortPlugin,
"sort-keys-plus": SortKeysPlusPlugin,
},
rules: {
"accessor-pairs": ["error"],
Expand Down Expand Up @@ -356,7 +358,8 @@ const CommonConfig = {
},
],
"sort-imports": ["off"],
"sort-keys": [
"sort-keys": ["off"],
"sort-keys-plus/sort-keys": [
"warn",
"asc",
{allowLineSeparatedGroups: true, caseSensitive: true, minKeys: 5, natural: true},
Expand Down
4 changes: 2 additions & 2 deletions StylisticConfigArray.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ const StylisticConfigArray = [
],
"@stylistic/lines-around-comment": [
"error",
/* eslint-disable sort-keys */
/* eslint-disable sort-keys-plus/sort-keys */
{
ignorePattern: "c8|Enum",
beforeBlockComment: true,
Expand All @@ -123,7 +123,7 @@ const StylisticConfigArray = [
allowTypeStart: true,
allowTypeEnd: true,
},
/* eslint-enable sort-keys */
/* eslint-enable sort-keys-plus/sort-keys */
],
"@stylistic/lines-between-class-members": ["error"],
"@stylistic/max-len": [
Expand Down
15 changes: 15 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"eslint-plugin-react": "^7.37.3",
"eslint-plugin-react-hooks": "^5.1.0",
"eslint-plugin-simple-import-sort": "^12.1.1",
"eslint-plugin-sort-keys-plus": "^1.4.0",
"globals": "^15.14.0",
"typescript-eslint": "8.19.0"
}
Expand Down