feat: sort eslint rules (#158)

* feat: sort eslint rules

* fix: use `sortObjectBy`

Author: fisker

index.js

@@ -75,7 +75,14 @@ const sortEslintConfig = onObject(
       onArray(overrides => overrides.map(sortEslintConfig)),
     ),
     overProperty('parserOptions', sortObject),
-    overProperty('rules', sortObject),
+    overProperty(
+      'rules',
+      sortObjectBy(
+        (rule1, rule2) =>
+          rule1.split('/').length - rule2.split('/').length ||
+          rule1.localeCompare(rule2),
+      ),
+    ),
     overProperty('settings', sortObject),
   ]),
 )

tests/eslint.js

@@ -25,7 +25,25 @@ test('eslintConfig', macro.sortObject, {
   value: keysToObject(['z', ...baseEslintConfigKeys, 'a']),
 })
 
-for (const key of ['env', 'globals', 'parserOptions', 'rules', 'settings']) {
+test('eslintConfig.rules', macro.sortObject, {
+  path: 'eslintConfig.rules',
+  expect: 'snapshot',
+  value: keysToObject([
+    'z',
+    'unknown-plugin/depth-1/depth-2',
+    'unicorn/new-for-builtins',
+    'unicorn/prefer-includes',
+    'for-direction',
+    'array-callback-return',
+    'yoda',
+    'prettier/prettier',
+    'react/display-name',
+    'react/jsx-key',
+    'a',
+  ]),
+})
+
+for (const key of ['env', 'globals', 'parserOptions', 'settings']) {
   const path = ['eslintConfig', key].join('.')
   test(path, macro.sortObjectAlphabetically, { path })
 }

tests/snapshots/cli.js.md

@@ -2,7 +2,7 @@
 
 The actual snapshot is saved in `cli.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
 
 ## run `cli --check` on 1 bad file
 

tests/snapshots/cli.js.snap

@@ -2,7 +2,7 @@
 
 The actual snapshot is saved in `deps.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
 
 ## peerDependenciesMeta
 

tests/snapshots/deps.js.md

@@ -2,7 +2,7 @@
 
 The actual snapshot is saved in `eslint.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
 
 ## eslintConfig
 
@@ -93,3 +93,46 @@ Generated by [AVA](https://ava.li).
         ]␊
       }␊
     }`
+
+## eslintConfig.rules
+
+> Should sort `eslintConfig.rules` as object.
+
+    {
+      input: `{␊
+        "eslintConfig": {␊
+          "rules": {␊
+            "z": "z",␊
+            "unknown-plugin/depth-1/depth-2": "unknown-plugin/depth-1/depth-2",␊
+            "unicorn/new-for-builtins": "unicorn/new-for-builtins",␊
+            "unicorn/prefer-includes": "unicorn/prefer-includes",␊
+            "for-direction": "for-direction",␊
+            "array-callback-return": "array-callback-return",␊
+            "yoda": "yoda",␊
+            "prettier/prettier": "prettier/prettier",␊
+            "react/display-name": "react/display-name",␊
+            "react/jsx-key": "react/jsx-key",␊
+            "a": "a"␊
+          }␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "eslintConfig": {␊
+          "rules": {␊
+            "a": "a",␊
+            "array-callback-return": "array-callback-return",␊
+            "for-direction": "for-direction",␊
+            "yoda": "yoda",␊
+            "z": "z",␊
+            "prettier/prettier": "prettier/prettier",␊
+            "react/display-name": "react/display-name",␊
+            "react/jsx-key": "react/jsx-key",␊
+            "unicorn/new-for-builtins": "unicorn/new-for-builtins",␊
+            "unicorn/prefer-includes": "unicorn/prefer-includes",␊
+            "unknown-plugin/depth-1/depth-2": "unknown-plugin/depth-1/depth-2"␊
+          }␊
+        }␊
+      }`,
+      pretty: true,
+    }

tests/snapshots/eslint.js.md

@@ -2,7 +2,7 @@
 
 The actual snapshot is saved in `fields.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
 
 ## badges
 

tests/snapshots/eslint.js.snap

@@ -2,7 +2,7 @@
 
 The actual snapshot is saved in `main.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
 
 ## default sortOrder
 

tests/snapshots/fields.js.md

@@ -2,7 +2,7 @@
 
 The actual snapshot is saved in `prettier.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
 
 ## prettier