feat!: support Eslint 9

.eslintrc.js

@@ -1,4 +1,3 @@
-'use strict'
 module.exports = {
   env: {
     node: true,

.gitignore

@@ -1 +1,2 @@
 node_modules
+.nyc_output

README.md

@@ -20,7 +20,26 @@ npm install eslint-plugin-optimize-regex --save-dev
 
 **Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-optimize-regex` globally.
 
-## Usage
+## Usage for Eslint 9 and above
+
+Add the following to your `eslint.config.mjs`
+
+```js
+import pluginOptimizeRegex from "eslint-plugin-optimize-regex";
+
+/** @type {import("eslint").Linter.FlatConfig[]} */
+export default [pluginOptimizeRegex.configs.recommended];
+```
+
+or the following to your `eslint.config.cjs`
+
+```js
+const pluginOptimizeRegex = require("eslint-plugin-optimize-regex").default
+
+module.exports = [pluginOptimizeRegex.configs.recommended]
+```
+
+## Usage for Eslint 8 and below
 
 Add `optimize-regex` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
@@ -61,15 +80,15 @@ If you want the latter particular settings, you can avoid setting `plugins` and
 
 ```json
 {
-  "extends": ["optimize-regex/recommended"]
+  "extends": ["optimize-regex/recommended-legacy"]
 }
 ```
 
 Or without the blacklist:
 
 ```json
 {
-  "extends": ["optimize-regex/all"]
+  "extends": ["optimize-regex/all-legacy"]
 }
 ```
 

eslint.config.mjs

@@ -0,0 +1,4 @@
+import pluginOptimizeRegex from "./lib/index.js";
+
+/** @type {import("eslint").Linter.FlatConfig[]} */
+export default [pluginOptimizeRegex.configs.recommended];

lib/index.d.ts

@@ -0,0 +1,12 @@
+import type { ESLint, Linter } from "eslint";
+
+declare const plugin: ESLint.Plugin & {
+  configs: {
+    recommended: Linter.FlatConfig;
+    "recommended-legacy": Linter.Config;
+    all: Linter.FlatConfig;
+    "all-legacy": Linter.Config;
+  };
+};
+
+export default plugin;

lib/index.js

@@ -3,27 +3,83 @@
  * @author Ezinwa Okpoechi <brainmaestro@outlook.com>
  */
 
-'use strict'
-
-module.exports = {
+/**
+ * @type {import("eslint").ESLint.Plugin}
+ */
+const plugin = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Optimize regex literals',
+      category: 'Best Practices',
+      recommended: true,
+      url: 'https://github.com/BrainMaestro/eslint-plugin-optimize-regex',
+    },
+  },
   rules: {
     'optimize-regex': require('./rules/optimize-regex'),
   },
-
   configs: {
-    recommended: {
-      plugins: ['optimize-regex'],
-      rules: {
-        'optimize-regex/optimize-regex': ['warn', {
-          'blacklist': ['charClassClassrangesMerge']
-        }]
-      }
-    },
-    all: {
-      plugins: ['optimize-regex'],
-      rules: {
-        'optimize-regex/optimize-regex': ['warn']
-      }
-    }
-  }
+    recommended: {},
+    'recommended-legacy': {},
+    all: {},
+    'all-legacy': {},
+  },
+}
+
+/**
+ * @type {import("eslint").Linter.FlatConfig}
+ */
+plugin.configs.recommended = {
+  plugins: {
+    'optimize-regex': plugin,
+  },
+  rules: {
+    'optimize-regex/optimize-regex': [
+      'warn',
+      {
+        blacklist: ['charClassClassrangesMerge'],
+      },
+    ],
+  },
 }
+
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+plugin.configs['recommended-legacy'] = {
+  plugins: ['optimize-regex'],
+  rules: {
+    'optimize-regex/optimize-regex': [
+      'warn',
+      {
+        blacklist: ['charClassClassrangesMerge'],
+      },
+    ],
+  },
+}
+
+/**
+ * @type {import("eslint").Linter.FlatConfig}
+ */
+plugin.configs.all = {
+  plugins: {
+    'optimize-regex': plugin,
+  },
+  rules: {
+    'optimize-regex/optimize-regex': ['warn'],
+  },
+}
+
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+plugin.configs['all-legacy'] = {
+  plugins: ['optimize-regex'],
+  rules: {
+    'optimize-regex/optimize-regex': ['warn'],
+  },
+}
+
+module.exports = plugin
+module.exports.default = plugin