Add recommended plugin config

Closes
#14

Author: NickvanDyke

README.md

@@ -22,16 +22,15 @@ yarn add -D eslint-plugin-react-you-might-not-need-an-effect
 
 ### Configuration
 
-Add the plugin to your ESLint configuration file.
+Add the plugin's recommended config to your ESLint configuration file.
 
 #### Legacy config (`.eslintrc`)
 
 ```js
 {
-  "plugins": ["react-you-might-not-need-an-effect"],
-  "rules": {
-    "react-you-might-not-need-an-effect/you-might-not-need-an-effect": "warn"
-  }
+  "extends": [
+    "plugin:react-you-might-not-need-an-effect/recommended"
+  ],
 }
 ```
 
@@ -41,24 +40,13 @@ Add the plugin to your ESLint configuration file.
 import youMightNotNeedAnEffect from "eslint-plugin-react-you-might-not-need-an-effect";
 
 export default [
-  {
-    files: ["**/*.{js,jsx}"],
-    plugins: {
-      "react-you-might-not-need-an-effect": youMightNotNeedAnEffect,
-    },
-    rules: {
-      "react-you-might-not-need-an-effect/you-might-not-need-an-effect": "warn",
-    },
-  },
+  youMightNotNeedAnEffect.configs.recommended
 ];
 ```
 
 ### Recommended
 
-The plugin will have more information to act upon when you:
-
-- Configure your [ESLint global variables](https://eslint.org/docs/latest/use/configure/language-options#predefined-global-variables)
-- Pass the correct dependencies to your effect — [`react-hooks/exhaustive-deps`](https://www.npmjs.com/package/eslint-plugin-react-hooks)
+The plugin will have more information to act upon when you pass the correct dependencies to your effect — [`react-hooks/exhaustive-deps`](https://www.npmjs.com/package/eslint-plugin-react-hooks).
 
 ## 🔎 Rule: `you-might-not-need-an-effect`
 

package.json

@@ -37,14 +37,14 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
-    "eslint-utils": "^3.0.0"
+    "eslint-utils": "^3.0.0",
+    "globals": "^16.2.0"
   },
   "devDependencies": {
     "esbuild": "^0.25.3",
     "eslint": "^9.20.1",
     "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-plugin-n": "^17.17.0",
-    "globals": "^16.2.0",
     "mocha": "11.1.0"
   },
   "peerDependencies": {

src/index.js

@@ -1,7 +1,40 @@
-import { name, rule } from "./rule.js";
+import { name as ruleName, rule } from "./rule.js";
+import globals from "globals";
 
-export default {
+const pluginName = "react-you-might-not-need-an-effect";
+
+const plugin = {
+  meta: {
+    name: pluginName,
+  },
+  configs: {
+    recommended: {},
+  },
   rules: {
-    [name]: rule,
+    [ruleName]: rule,
   },
 };
+
+Object.assign(plugin.configs.recommended, {
+  files: ["**/*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}"],
+  plugins: {
+    // Object.assign above so we can reference `plugin` here
+    [pluginName]: plugin,
+  },
+  rules: {
+    [pluginName + "/" + ruleName]: "warn",
+  },
+  languageOptions: {
+    globals: {
+      // NOTE: Required so we can resolve global references to their upstream global variables
+      ...globals.browser,
+    },
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+  },
+});
+
+export default plugin;

types/index.d.ts

@@ -1,4 +1,8 @@
 import type { ESLint } from "eslint";
 
-declare const plugin: ESLint.Plugin;
+declare const plugin: ESLint.Plugin & {
+  configs: {
+    recommended: ESLint.ConfigData;
+  };
+};
 export default plugin;