lint

Author: francoismassart

README.md

@@ -6,11 +6,13 @@
 
 <!-- begin auto-generated rules list -->
 
+⚠️ Configurations set to warn in.\
+✅ Set in the `recommended` configuration.\
 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
-| Name                             | Description            | 💡  |
-| :------------------------------- | :--------------------- | :-- |
-| [my-rule](docs/rules/my-rule.md) | An example ESLint rule | 💡  |
+| Name                             | Description            | ⚠️  | 💡  |
+| :------------------------------- | :--------------------- | :-- | :-- |
+| [my-rule](docs/rules/my-rule.md) | An example ESLint rule | ✅  | 💡  |
 
 <!-- end auto-generated rules list -->
 

docs/rules/my-rule.md

@@ -1,5 +1,7 @@
 # An example ESLint rule
 
+⚠️ This rule _warns_ in the ✅ `recommended` config.
+
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->

eslint.config.mjs

@@ -2,6 +2,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 
 import pluginJs from "@eslint/js";
+import eslintPlugin from "eslint-plugin-eslint-plugin";
 import importPlugin from "eslint-plugin-import";
 import simpleImportSort from "eslint-plugin-simple-import-sort";
 import eslintPluginUnicorn from "eslint-plugin-unicorn";
@@ -22,6 +23,7 @@ export default [
   },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,
+  eslintPlugin.configs.recommended,
   {
     plugins: {
       import: importPlugin,

package.json

@@ -67,6 +67,7 @@
     "@typescript-eslint/rule-tester": "^8.37.0",
     "eslint": "^9.31.0",
     "eslint-doc-generator": "^2.2.2",
+    "eslint-plugin-eslint-plugin": "^7.0.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unicorn": "^56.0.1",

pnpm-lock.yaml

@@ -1,3 +1,6 @@
+/* eslint-disable eslint-plugin/no-meta-schema-default */
+// Meta schema `default` is read by the `eslint-doc-generator`
+
 import { RuleCreator } from "@typescript-eslint/utils/eslint-utils";
 
 import type { PluginSharedSettings } from "../types";
@@ -20,6 +23,8 @@ type Options = [
 // The parameter passed into RuleCreator is a URL generator function.
 export const createRule = RuleCreator(urlCreator);
 
+const defaultOptions = { someBool: true, someEnum: "always" };
+
 export const myRule = createRule<Options, MessageIds>({
   name: RULE_NAME,
   meta: {
@@ -51,6 +56,7 @@ export const myRule = createRule<Options, MessageIds>({
         additionalProperties: false,
       },
     ],
+    defaultOptions: [defaultOptions],
     type: "suggestion",
   },
   /**
@@ -60,7 +66,7 @@ export const myRule = createRule<Options, MessageIds>({
    * - If some configuration is provided as the second argument, it is ignored, not merged
    * - In other words, the `defaultOptions` is only used when the rule is used without configuration
    */
-  defaultOptions: [{ someBool: false, someEnum: "always" }],
+  defaultOptions: [defaultOptions],
   create: (context, options) => {
     return {
       VariableDeclaration: (node) => {