update to eslint 9

Author: fxOne

CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## To Be Released
 
+## 3.0.0
+
+- Update to eslint 9
+
 ## 2.3.0
 
 - Add support for suggestions

README.md

@@ -4,6 +4,10 @@ Extended short-key rule to handle shorthand properties as ESLint doesn't want to
 
 - https://github.com/eslint/eslint/issues/7543
 
+# ESLint 9+ Support
+
+This plugin is compatible with **ESLint 9 and above**. If you are using ESLint 9+, please use the new [flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) format as shown below.
+
 # Installation
 
 Install [ESLint](https://www.github.com/eslint/eslint) either locally or globally. (Note that locally, per project, is strongly preferred)
@@ -12,50 +16,43 @@ Install [ESLint](https://www.github.com/eslint/eslint) either locally or globall
 $ npm install eslint --save-dev
 ```
 
-If you installed `ESLint` globally, you have to install React plugin globally too. Otherwise, install it locally.
+If you installed `ESLint` globally, you have to install this plugin globally too. Otherwise, install it locally.
 
 ```sh
 $ npm install eslint-plugin-sort-keys-shorthand --save-dev
 ```
 
-# Configuration
-
-Add "sort-keys-shorthand" to the plugins section.
-
-```json
-{
-  "plugins": ["sort-keys-shorthand"]
-}
-```
-
-Deactivate the original `sort-keys` rule.
-
-```json
-{
-  "rules": {
-    "sort-keys": 0
+# Configuration (ESLint 9+ Flat Config Example)
+
+Create an `eslint.config.js` file in your project root:
+
+```js
+import sortKeysShorthand from 'eslint-plugin-sort-keys-shorthand';
+
+export default [
+  {
+    plugins: {
+      'sort-keys-shorthand': sortKeysShorthand
+    },
+    rules: {
+      'sort-keys-shorthand/sort-keys-shorthand': [
+        'error',
+        'asc',
+        {
+          caseSensitive: true,
+          minKeys: 2,
+          natural: false,
+          shorthand: 'first'
+        }
+      ]
+    }
   }
-}
+];
 ```
 
-Enable `sort-keys-shorthand`:
-
-```json
-{
-  "rules": {
-    "sort-keys-shorthand/sort-keys-shorthand": [
-      "error",
-      "asc",
-      {
-        "caseSensitive": true,
-        "minKeys": 2,
-        "natural": false,
-        "shorthand": "first"
-      }
-    ]
-  }
-}
-```
+# Migration from .eslintrc
+
+If you are migrating from `.eslintrc` to flat config, move your plugin and rule configuration as shown above. The old `.eslintrc` format is no longer recommended for ESLint 9+.
 
 # Rules
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-sort-keys-shorthand",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "eslint plugin which support sorting shorthand keys",
   "main": "index.js",
   "scripts": {
@@ -11,16 +11,16 @@
     "eslint"
   ],
   "peerDependencies": {
-    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+    "eslint": "^9.0.0"
   },
   "author": "Dominic Buetow",
   "license": "MIT",
   "devDependencies": {
     "@changesets/cli": "^2.27.1",
-    "eslint": "^8",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint": "^9.29.0",
+    "eslint-plugin-import": "^2.31.0",
     "istanbul": "^0.4.5",
-    "mocha": "10.4.0"
+    "mocha": "11.7.0"
   },
   "dependencies": {
     "natural-compare": "^1.4.0"