eslint-plugin-remeda 1.4.0 → 1.5.0

package/README.md

@@ -2,42 +2,52 @@
 
 ESLint plugin for [Remeda](https://github.com/remeda/remeda).
 
+## Preamble
+
+This plugin was originally derived from [eslint-plugin-lodash-f](https://github.com/AndreaPontrandolfo/eslint-plugin-lodash) (fork of [eslint-plugin-lodash](https://github.com/wix-incubator/eslint-plugin-lodash)) and used that as a base to build upon.
+
 ## Installation
 
 First, you'll first need to install [ESLint](https://eslint.org/):
 
 ```sh
-npm add eslint -D
+pnpm add -D eslint
 ```
 
 Next, install `eslint-plugin-remeda`:
 
 ```sh
-npm add eslint-plugin-remeda -D
+pnpm add -D eslint-plugin-remeda
 ```
 
-## Preamble
-
-This plugin was originally derived from [eslint-plugin-lodash-f](https://github.com/AndreaPontrandolfo/eslint-plugin-lodash) (fork of [eslint-plugin-lodash](https://github.com/wix-incubator/eslint-plugin-lodash)) and used that as a base to build upon.
-
 ## Rules
 
 Enable all of the rules that you would like to use. All rules are off by default, unless you use one of the plugin's configurations which turn all relevant rules on.
 
-- [collection-method-value](docs/rules/collection-method-value.md): Use value returned from collection methods properly.
-- [collection-return](docs/rules/collection-return.md): Always return a value in iteratees of Remeda collection methods that aren't `forEach`.
-- [prefer-filter](docs/rules/prefer-filter.md): Prefer `R.filter` over `R.forEach` with an `if` statement inside.
-- [prefer-find](docs/rules/prefer-find.md): Prefer `R.find` over `R.filter` followed by selecting the first result.
-- [prefer-flat-map](docs/rules/prefer-flat-map.md): Prefer `R.flatMap` over consecutive `R.map` and `R.flat`.
-- [prefer-map](docs/rules/prefer-map.md): Prefer `R.map` over `R.forEach` with a `push` inside.
-- [prefer-nullish-coalescing](docs/rules/prefer-nullish-coalescing.md): Prefer `??` when doing a comparison with a non-nullish value as test.
-- [prefer-constant](docs/rules/prefer-constant.md): Prefer `R.constant` over functions returning literals.
-- [prefer-is-empty](docs/rules/prefer-is-empty.md): Prefer `R.isEmpty` over manual checking for length value.
-- [prefer-is-nil](docs/rules/prefer-is-nil.md): Prefer `R.isNil` over checks for both null and undefined.
-- [prefer-remeda-typecheck](docs/rules/prefer-remeda-typecheck.md): Prefer using `R.is*` methods over `typeof` and `instanceof` checks when applicable.
-- [prefer-do-nothing](docs/rules/prefer-do-nothing.md): Prefer `R.doNothing` over empty functions.
-- [prefer-some](docs/rules/prefer-some.md): Prefer using `R.some` over comparing `findIndex` to -1.
-- [prefer-times](docs/rules/prefer-times.md): Prefer `R.times` over `R.map` without using the iteratee's arguments.
+<!-- begin auto-generated rules list -->
+
+💼 Configurations enabled in.\
+✅ Set in the `recommended` configuration.\
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+
+| Name                                                                 | 💼  | 🔧  |
+| :------------------------------------------------------------------- | :-- | :-- |
+| [collection-method-value](docs/rules/collection-method-value.md)     | ✅  |     |
+| [collection-return](docs/rules/collection-return.md)                 | ✅  |     |
+| [prefer-constant](docs/rules/prefer-constant.md)                     | ✅  |     |
+| [prefer-do-nothing](docs/rules/prefer-do-nothing.md)                 | ✅  |     |
+| [prefer-filter](docs/rules/prefer-filter.md)                         | ✅  |     |
+| [prefer-find](docs/rules/prefer-find.md)                             | ✅  |     |
+| [prefer-flat-map](docs/rules/prefer-flat-map.md)                     | ✅  |     |
+| [prefer-is-empty](docs/rules/prefer-is-empty.md)                     | ✅  | 🔧  |
+| [prefer-is-nullish](docs/rules/prefer-is-nullish.md)                 | ✅  |     |
+| [prefer-map](docs/rules/prefer-map.md)                               | ✅  |     |
+| [prefer-nullish-coalescing](docs/rules/prefer-nullish-coalescing.md) | ✅  | 🔧  |
+| [prefer-remeda-typecheck](docs/rules/prefer-remeda-typecheck.md)     | ✅  |     |
+| [prefer-some](docs/rules/prefer-some.md)                             | ✅  |     |
+| [prefer-times](docs/rules/prefer-times.md)                           | ✅  |     |
+
+<!-- end auto-generated rules list -->
 
 ## Contributing
 

package/dist/index.cjs

@@ -45,6 +45,8 @@ var package_default = {
     attw: "attw --pack .",
     qa: "pnpm typecheck && pnpm test && pnpm knip && pnpm publint && attw",
     nuke: "rm -rf node_modules pnpm-lock.yaml",
+    "update:eslint-docs": "eslint-doc-generator",
+    "lint:eslint-docs": "pnpm update:eslint-docs -- --check",
     "semantic-release": "pnpm build && semantic-release"
   },
   files: [
@@ -77,7 +79,8 @@ var package_default = {
     eslint: "9.10.0",
     "eslint-config-sheriff": "^21.2.0",
     "eslint-define-config": "^2.1.0",
-    "eslint-plugin-eslint-plugin": "^6.2.0",
+    "eslint-doc-generator": "^2.1.2",
+    "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-vitest-rule-tester": "^0.3.3",
     knip: "^5.29.1",
     prettier: "^3.3.2",
@@ -450,8 +453,8 @@ __export(methodData_exports, {
   isMatchWith: () => isMatchWith,
   isNaN: () => isNaN,
   isNative: () => isNative,
-  isNil: () => isNil,
   isNull: () => isNull,
+  isNullish: () => isNullish,
   isNumber: () => isNumber,
   isObject: () => isObject,
   isObjectLike: () => isObjectLike,
@@ -1478,7 +1481,7 @@ var isNative = {
   iteratee: false,
   args: 1
 };
-var isNil = {
+var isNullish = {
   wrapper: false,
   shorthand: false,
   chainable: false,
@@ -2987,6 +2990,7 @@ var meta = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Use value returned from collection methods properly",
     url: getDocsUrl("collection-method-value")
   }
 };
@@ -3030,6 +3034,7 @@ var meta2 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Always return a value in iteratees of Remeda collection methods that aren't `forEach`",
     url: getDocsUrl("collection-return")
   }
 };
@@ -3083,6 +3088,7 @@ var { getValueReturnedInFirstStatement: getValueReturnedInFirstStatement2 } = as
 var meta3 = {
   type: "problem",
   docs: {
+    description: "Prefer R.constant over functions returning literals",
     url: getDocsUrl("prefer-constant")
   },
   schema: [
@@ -3155,6 +3161,7 @@ var meta4 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.doNothing() or R.constant(undefined) over an empty function",
     url: getDocsUrl("prefer-do-nothing")
   }
 };
@@ -3193,6 +3200,7 @@ var {
 var meta5 = {
   type: "problem",
   docs: {
+    description: "Prefer R.filter or R.some over an if statement inside a R.forEach",
     url: getDocsUrl("prefer-filter")
   },
   schema: [
@@ -3235,6 +3243,7 @@ var meta6 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer using `R.find` over selecting the first item of a filtered result",
     url: getDocsUrl("prefer-find")
   }
 };
@@ -3278,6 +3287,7 @@ var meta7 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.flatMap over consecutive R.map and R.flat.",
     url: getDocsUrl("prefer-flat-map")
   }
 };
@@ -3309,6 +3319,7 @@ var meta8 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.isEmpty over manually checking for length value.",
     url: getDocsUrl("prefer-is-empty")
   },
   fixable: "code"
@@ -3409,14 +3420,15 @@ var rule8 = {
 var RULE_NAME8 = "prefer-is-empty";
 var prefer_is_empty_default = rule8;
 
-// src/rules/prefer-is-nil.ts
+// src/rules/prefer-is-nullish.ts
 var import_lodash_es8 = require("lodash-es");
 var { isNegationExpression: isNegationExpression2, isEquivalentMemberExp: isEquivalentMemberExp2 } = astUtil_default;
 var meta9 = {
   type: "problem",
   schema: [],
   docs: {
-    url: getDocsUrl("prefer-is-nil")
+    description: "Prefer R.isNullish over checks for both null and undefined.",
+    url: getDocsUrl("prefer-is-nullish")
   }
 };
 function create10(context) {
@@ -3491,13 +3503,13 @@ function create10(context) {
       if (isEquivalentExistingExpression(node, "undefined", "null") || isEquivalentExistingExpression(node, "null", "undefined")) {
         context.report({
           node,
-          message: "Prefer isNil over checking for undefined or null."
+          message: "Prefer isNullish over checking for undefined or null."
         });
       }
     } else if (isEquivalentExistingNegation(node, "undefined", "null") || isEquivalentExistingNegation(node, "null", "undefined")) {
       context.report({
         node,
-        message: "Prefer isNil over checking for undefined or null."
+        message: "Prefer isNullish over checking for undefined or null."
       });
     }
   };
@@ -3507,8 +3519,8 @@ var rule9 = {
   create: create10,
   meta: meta9
 };
-var RULE_NAME9 = "prefer-is-nil";
-var prefer_is_nil_default = rule9;
+var RULE_NAME9 = "prefer-is-nullish";
+var prefer_is_nullish_default = rule9;
 
 // src/rules/prefer-map.ts
 var import_lodash_es9 = require("lodash-es");
@@ -3523,6 +3535,7 @@ var meta10 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.map over a R.forEach with a push to an array inside",
     url: getDocsUrl("prefer-map")
   }
 };
@@ -3560,6 +3573,7 @@ var meta11 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer nullish coalescing over checking a ternary with !isNullish.",
     url: getDocsUrl("prefer-nullish-coalescing")
   },
   fixable: "code"
@@ -3578,7 +3592,7 @@ function create12(context) {
   visitors.ConditionalExpression = function(node) {
     const statement = node.test;
     if (statement.operator === "!") {
-      if (statement.argument && statement.argument.callee && statement.argument.callee.name && statement.argument.callee.name === "isNullish") {
+      if (statement.argument?.callee?.name && statement.argument.callee.name === "isNullish") {
         const argument = getTextOfNode(statement.argument.arguments[0]);
         const consequent = getTextOfNode(node.consequent);
         const alternate = getTextOfNode(node.alternate);
@@ -3609,6 +3623,7 @@ var meta12 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer using `R.is*` methods over `typeof` and `instanceof` checks when applicable.",
     url: getDocsUrl("prefer-remeda-typecheck")
   }
 };
@@ -3681,6 +3696,7 @@ var { getExpressionComparedToInt: getExpressionComparedToInt2 } = astUtil_defaul
 var meta13 = {
   type: "problem",
   docs: {
+    description: "Prefer R.some over findIndex comparison to -1",
     url: getDocsUrl("prefer-some")
   },
   schema: []
@@ -3712,6 +3728,7 @@ var meta14 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.times over R.map without using arguments",
     url: getDocsUrl("prefer-times")
   }
 };
@@ -3742,7 +3759,7 @@ var rules = {
   [RULE_NAME6]: prefer_find_default,
   [RULE_NAME7]: prefer_flat_map_default,
   [RULE_NAME8]: prefer_is_empty_default,
-  [RULE_NAME9]: prefer_is_nil_default,
+  [RULE_NAME9]: prefer_is_nullish_default,
   [RULE_NAME10]: prefer_map_default,
   [RULE_NAME11]: prefer_nullish_coalescing_default,
   [RULE_NAME12]: prefer_remeda_typecheck_default,
@@ -3766,7 +3783,7 @@ Object.assign(plugin.configs, {
     },
     rules: {
       [`${pluginShortName}/prefer-is-empty`]: 2,
-      [`${pluginShortName}/prefer-is-nil`]: 2,
+      [`${pluginShortName}/prefer-is-nullish`]: 2,
       [`${pluginShortName}/prefer-times`]: 2,
       [`${pluginShortName}/prefer-constant`]: 2,
       [`${pluginShortName}/prefer-remeda-typecheck`]: 2,

package/dist/index.d.cts

@@ -14,6 +14,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Use value returned from collection methods properly";
                     readonly url: string;
                 };
             };
@@ -38,6 +39,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Always return a value in iteratees of Remeda collection methods that aren't `forEach`";
                     readonly url: string;
                 };
             };
@@ -51,6 +53,7 @@ declare const plugin: {
             meta: {
                 readonly type: "problem";
                 readonly docs: {
+                    readonly description: "Prefer R.constant over functions returning literals";
                     readonly url: string;
                 };
                 readonly schema: readonly [{
@@ -69,6 +72,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.doNothing() or R.constant(undefined) over an empty function";
                     readonly url: string;
                 };
             };
@@ -78,6 +82,7 @@ declare const plugin: {
             meta: {
                 readonly type: "problem";
                 readonly docs: {
+                    readonly description: "Prefer R.filter or R.some over an if statement inside a R.forEach";
                     readonly url: string;
                 };
                 readonly schema: readonly [{
@@ -91,6 +96,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer using `R.find` over selecting the first item of a filtered result";
                     readonly url: string;
                 };
             };
@@ -101,6 +107,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.flatMap over consecutive R.map and R.flat.";
                     readonly url: string;
                 };
             };
@@ -111,17 +118,19 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.isEmpty over manually checking for length value.";
                     readonly url: string;
                 };
                 readonly fixable: "code";
             };
         };
-        "prefer-is-nil": {
+        "prefer-is-nullish": {
             create: (context: any) => RemedaMethodVisitors;
             meta: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.isNullish over checks for both null and undefined.";
                     readonly url: string;
                 };
             };
@@ -132,6 +141,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.map over a R.forEach with a push to an array inside";
                     readonly url: string;
                 };
             };
@@ -142,6 +152,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer nullish coalescing over checking a ternary with !isNullish.";
                     readonly url: string;
                 };
                 readonly fixable: "code";
@@ -155,6 +166,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer using `R.is*` methods over `typeof` and `instanceof` checks when applicable.";
                     readonly url: string;
                 };
             };
@@ -164,6 +176,7 @@ declare const plugin: {
             meta: {
                 readonly type: "problem";
                 readonly docs: {
+                    readonly description: "Prefer R.some over findIndex comparison to -1";
                     readonly url: string;
                 };
                 readonly schema: readonly [];
@@ -175,6 +188,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.times over R.map without using arguments";
                     readonly url: string;
                 };
             };

package/dist/index.d.ts

@@ -14,6 +14,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Use value returned from collection methods properly";
                     readonly url: string;
                 };
             };
@@ -38,6 +39,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Always return a value in iteratees of Remeda collection methods that aren't `forEach`";
                     readonly url: string;
                 };
             };
@@ -51,6 +53,7 @@ declare const plugin: {
             meta: {
                 readonly type: "problem";
                 readonly docs: {
+                    readonly description: "Prefer R.constant over functions returning literals";
                     readonly url: string;
                 };
                 readonly schema: readonly [{
@@ -69,6 +72,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.doNothing() or R.constant(undefined) over an empty function";
                     readonly url: string;
                 };
             };
@@ -78,6 +82,7 @@ declare const plugin: {
             meta: {
                 readonly type: "problem";
                 readonly docs: {
+                    readonly description: "Prefer R.filter or R.some over an if statement inside a R.forEach";
                     readonly url: string;
                 };
                 readonly schema: readonly [{
@@ -91,6 +96,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer using `R.find` over selecting the first item of a filtered result";
                     readonly url: string;
                 };
             };
@@ -101,6 +107,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.flatMap over consecutive R.map and R.flat.";
                     readonly url: string;
                 };
             };
@@ -111,17 +118,19 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.isEmpty over manually checking for length value.";
                     readonly url: string;
                 };
                 readonly fixable: "code";
             };
         };
-        "prefer-is-nil": {
+        "prefer-is-nullish": {
             create: (context: any) => RemedaMethodVisitors;
             meta: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.isNullish over checks for both null and undefined.";
                     readonly url: string;
                 };
             };
@@ -132,6 +141,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.map over a R.forEach with a push to an array inside";
                     readonly url: string;
                 };
             };
@@ -142,6 +152,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer nullish coalescing over checking a ternary with !isNullish.";
                     readonly url: string;
                 };
                 readonly fixable: "code";
@@ -155,6 +166,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer using `R.is*` methods over `typeof` and `instanceof` checks when applicable.";
                     readonly url: string;
                 };
             };
@@ -164,6 +176,7 @@ declare const plugin: {
             meta: {
                 readonly type: "problem";
                 readonly docs: {
+                    readonly description: "Prefer R.some over findIndex comparison to -1";
                     readonly url: string;
                 };
                 readonly schema: readonly [];
@@ -175,6 +188,7 @@ declare const plugin: {
                 readonly type: "problem";
                 readonly schema: readonly [];
                 readonly docs: {
+                    readonly description: "Prefer R.times over R.map without using arguments";
                     readonly url: string;
                 };
             };

package/dist/index.js

@@ -27,6 +27,8 @@ var package_default = {
     attw: "attw --pack .",
     qa: "pnpm typecheck && pnpm test && pnpm knip && pnpm publint && attw",
     nuke: "rm -rf node_modules pnpm-lock.yaml",
+    "update:eslint-docs": "eslint-doc-generator",
+    "lint:eslint-docs": "pnpm update:eslint-docs -- --check",
     "semantic-release": "pnpm build && semantic-release"
   },
   files: [
@@ -59,7 +61,8 @@ var package_default = {
     eslint: "9.10.0",
     "eslint-config-sheriff": "^21.2.0",
     "eslint-define-config": "^2.1.0",
-    "eslint-plugin-eslint-plugin": "^6.2.0",
+    "eslint-doc-generator": "^2.1.2",
+    "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-vitest-rule-tester": "^0.3.3",
     knip: "^5.29.1",
     prettier: "^3.3.2",
@@ -444,8 +447,8 @@ __export(methodData_exports, {
   isMatchWith: () => isMatchWith,
   isNaN: () => isNaN,
   isNative: () => isNative,
-  isNil: () => isNil,
   isNull: () => isNull,
+  isNullish: () => isNullish,
   isNumber: () => isNumber,
   isObject: () => isObject,
   isObjectLike: () => isObjectLike,
@@ -1472,7 +1475,7 @@ var isNative = {
   iteratee: false,
   args: 1
 };
-var isNil = {
+var isNullish = {
   wrapper: false,
   shorthand: false,
   chainable: false,
@@ -2981,6 +2984,7 @@ var meta = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Use value returned from collection methods properly",
     url: getDocsUrl("collection-method-value")
   }
 };
@@ -3024,6 +3028,7 @@ var meta2 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Always return a value in iteratees of Remeda collection methods that aren't `forEach`",
     url: getDocsUrl("collection-return")
   }
 };
@@ -3077,6 +3082,7 @@ var { getValueReturnedInFirstStatement: getValueReturnedInFirstStatement2 } = as
 var meta3 = {
   type: "problem",
   docs: {
+    description: "Prefer R.constant over functions returning literals",
     url: getDocsUrl("prefer-constant")
   },
   schema: [
@@ -3149,6 +3155,7 @@ var meta4 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.doNothing() or R.constant(undefined) over an empty function",
     url: getDocsUrl("prefer-do-nothing")
   }
 };
@@ -3187,6 +3194,7 @@ var {
 var meta5 = {
   type: "problem",
   docs: {
+    description: "Prefer R.filter or R.some over an if statement inside a R.forEach",
     url: getDocsUrl("prefer-filter")
   },
   schema: [
@@ -3229,6 +3237,7 @@ var meta6 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer using `R.find` over selecting the first item of a filtered result",
     url: getDocsUrl("prefer-find")
   }
 };
@@ -3272,6 +3281,7 @@ var meta7 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.flatMap over consecutive R.map and R.flat.",
     url: getDocsUrl("prefer-flat-map")
   }
 };
@@ -3303,6 +3313,7 @@ var meta8 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.isEmpty over manually checking for length value.",
     url: getDocsUrl("prefer-is-empty")
   },
   fixable: "code"
@@ -3403,14 +3414,15 @@ var rule8 = {
 var RULE_NAME8 = "prefer-is-empty";
 var prefer_is_empty_default = rule8;
 
-// src/rules/prefer-is-nil.ts
+// src/rules/prefer-is-nullish.ts
 import { cond as cond3, find as find2, map as map2, matches as matches3, property as property3 } from "lodash-es";
 var { isNegationExpression: isNegationExpression2, isEquivalentMemberExp: isEquivalentMemberExp2 } = astUtil_default;
 var meta9 = {
   type: "problem",
   schema: [],
   docs: {
-    url: getDocsUrl("prefer-is-nil")
+    description: "Prefer R.isNullish over checks for both null and undefined.",
+    url: getDocsUrl("prefer-is-nullish")
   }
 };
 function create10(context) {
@@ -3485,13 +3497,13 @@ function create10(context) {
       if (isEquivalentExistingExpression(node, "undefined", "null") || isEquivalentExistingExpression(node, "null", "undefined")) {
         context.report({
           node,
-          message: "Prefer isNil over checking for undefined or null."
+          message: "Prefer isNullish over checking for undefined or null."
         });
       }
     } else if (isEquivalentExistingNegation(node, "undefined", "null") || isEquivalentExistingNegation(node, "null", "undefined")) {
       context.report({
         node,
-        message: "Prefer isNil over checking for undefined or null."
+        message: "Prefer isNullish over checking for undefined or null."
       });
     }
   };
@@ -3501,8 +3513,8 @@ var rule9 = {
   create: create10,
   meta: meta9
 };
-var RULE_NAME9 = "prefer-is-nil";
-var prefer_is_nil_default = rule9;
+var RULE_NAME9 = "prefer-is-nullish";
+var prefer_is_nullish_default = rule9;
 
 // src/rules/prefer-map.ts
 import { get as get6, includes as includes6 } from "lodash-es";
@@ -3517,6 +3529,7 @@ var meta10 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.map over a R.forEach with a push to an array inside",
     url: getDocsUrl("prefer-map")
   }
 };
@@ -3554,6 +3567,7 @@ var meta11 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer nullish coalescing over checking a ternary with !isNullish.",
     url: getDocsUrl("prefer-nullish-coalescing")
   },
   fixable: "code"
@@ -3572,7 +3586,7 @@ function create12(context) {
   visitors.ConditionalExpression = function(node) {
     const statement = node.test;
     if (statement.operator === "!") {
-      if (statement.argument && statement.argument.callee && statement.argument.callee.name && statement.argument.callee.name === "isNullish") {
+      if (statement.argument?.callee?.name && statement.argument.callee.name === "isNullish") {
         const argument = getTextOfNode(statement.argument.arguments[0]);
         const consequent = getTextOfNode(node.consequent);
         const alternate = getTextOfNode(node.alternate);
@@ -3603,6 +3617,7 @@ var meta12 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer using `R.is*` methods over `typeof` and `instanceof` checks when applicable.",
     url: getDocsUrl("prefer-remeda-typecheck")
   }
 };
@@ -3675,6 +3690,7 @@ var { getExpressionComparedToInt: getExpressionComparedToInt2 } = astUtil_defaul
 var meta13 = {
   type: "problem",
   docs: {
+    description: "Prefer R.some over findIndex comparison to -1",
     url: getDocsUrl("prefer-some")
   },
   schema: []
@@ -3706,6 +3722,7 @@ var meta14 = {
   type: "problem",
   schema: [],
   docs: {
+    description: "Prefer R.times over R.map without using arguments",
     url: getDocsUrl("prefer-times")
   }
 };
@@ -3736,7 +3753,7 @@ var rules = {
   [RULE_NAME6]: prefer_find_default,
   [RULE_NAME7]: prefer_flat_map_default,
   [RULE_NAME8]: prefer_is_empty_default,
-  [RULE_NAME9]: prefer_is_nil_default,
+  [RULE_NAME9]: prefer_is_nullish_default,
   [RULE_NAME10]: prefer_map_default,
   [RULE_NAME11]: prefer_nullish_coalescing_default,
   [RULE_NAME12]: prefer_remeda_typecheck_default,
@@ -3760,7 +3777,7 @@ Object.assign(plugin.configs, {
     },
     rules: {
       [`${pluginShortName}/prefer-is-empty`]: 2,
-      [`${pluginShortName}/prefer-is-nil`]: 2,
+      [`${pluginShortName}/prefer-is-nullish`]: 2,
       [`${pluginShortName}/prefer-times`]: 2,
       [`${pluginShortName}/prefer-constant`]: 2,
       [`${pluginShortName}/prefer-remeda-typecheck`]: 2,

package/docs/rules/collection-method-value.md

@@ -1,4 +1,8 @@
-# Collection Method Value
+# remeda/collection-method-value
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When using a Remeda collection method, the expression should be used (e.g. assigning to a variable or check in a condition), unless it's a method meant for side effects (e.g. `forEach` or `forOwn`) which should NOT be used.
 

package/docs/rules/collection-return.md

@@ -1,4 +1,8 @@
-# Collection Return Statement
+# remeda/collection-return
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When using a Remeda collection method that isn't forEach, the iteratee should return a value, otherwise it could result in either unclear code or unexpected results.
 

package/docs/rules/prefer-constant.md

@@ -1,4 +1,8 @@
-# Prefer constant
+# remeda/prefer-constant
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When you want a function that always returns the same value, it can be more concise to use `R.constant`.
 
@@ -9,6 +13,10 @@ This rule takes two arguments:
 - whether or not to check arrow functions
 - whether or not to check function declarations (named functions)
 
+## Options
+
+## Examples
+
 The following patterns are considered warnings:
 
 ```js

package/docs/rules/prefer-do-nothing.md

@@ -1,4 +1,8 @@
-# Prefer noop
+# remeda/prefer-do-nothing
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When defining an empty function (e.g. for callbacks) it can be more readable to use `R.doNothing()` or `R.constant(undefined)` instead. Use `R.doNothing()` if you need to return void, otherwise use `R.constant(undefined)`.
 

package/docs/rules/prefer-filter.md

@@ -1,4 +1,8 @@
-# Prefer filter
+# remeda/prefer-filter
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When using R.forEach with a single `if` statement, you should probably use `R.filter` or `R.some` instead.
 
@@ -6,6 +10,10 @@ When using R.forEach with a single `if` statement, you should probably use `R.fi
 
 This rule takes one argument, maximum path length (default is 3).
 
+## Options
+
+## Examples
+
 The following patterns are considered warnings:
 
 ```js

package/docs/rules/prefer-find.md

@@ -1,4 +1,8 @@
-# Prefer find
+# remeda/prefer-find
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When using R.filter and accessing the first or last result, you should probably use `R.find` or `R.findLast`, respectively.
 

package/docs/rules/prefer-flat-map.md

@@ -1,4 +1,8 @@
-# Prefer [`R.flatMap`] over consecutive [`R.map`] and [`R.flat`]
+# remeda/prefer-flat-map
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When using [`R.map`] and [`R.flat`], it can be more concise to use [`R.flatMap`] instead.
 

package/docs/rules/prefer-is-empty.md

@@ -1,4 +1,10 @@
-# Prefer R.isEmpty
+# remeda/prefer-is-empty
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
 When checking if a collection is empty or no, it is more concise to use R.isEmpty instead.
 

package/docs/rules/{prefer-is-nil.md → prefer-is-nullish.md}

@@ -1,6 +1,6 @@
-# Prefer R.isNil
+# Prefer R.isNullish
 
-When checking that a value is undefined or null (but not false or ''), it is more concise to use R.isNil instead.
+When checking that a value is undefined or null (but not false or ''), it is more concise to use R.isNullish instead.
 
 ## Rule Details
 
@@ -17,11 +17,11 @@ var t = x === undefined || x === null;
 The following patterns are not considered warnings:
 
 ```js
-var t = R.isNil(x);
+var t = R.isNullish(x);
 
 var t = R.isUndefined(x) || R.isNull(y);
 ```
 
 ## When Not To Use It
 
-If you do not want to enforce using `R.isNil`, and prefer using specific checks instead.
+If you do not want to enforce using `R.isNullish`, and prefer using specific checks instead.

package/docs/rules/prefer-map.md

@@ -1,4 +1,8 @@
-# Prefer map
+# remeda/prefer-map
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When using `R.forEach` that pushes into an array, it could improve readability to use `R.map` instead.
 

package/docs/rules/prefer-nullish-coalescing.md

@@ -1,4 +1,10 @@
-# Prefer nullish coalescing over checking a ternary with !isNil.
+# remeda/prefer-nullish-coalescing
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
 When checking if a variable is not nil as a test for a ternary equation, it's more coincise to just use the nullish coalescing operator.
 
@@ -9,13 +15,13 @@ This rule takes no arguments.
 The following patterns are considered warnings:
 
 ```js
-const myExpression = !isNil(myVar) ? myVar : myOtherVar;
+const myExpression = !isNullish(myVar) ? myVar : myOtherVar;
 ```
 
 The following patterns are not considered warnings:
 
 ```js
-const myExpression = !isNil(myVar) ? mySecondVar : myThirdVar;
+const myExpression = !isNullish(myVar) ? mySecondVar : myThirdVar;
 
 const myExpression = myVar ?? myOtherVar;
 ```

package/docs/rules/prefer-remeda-typecheck.md

@@ -1,4 +1,8 @@
-# Prefer Remeda typecheck
+# remeda/prefer-remeda-typecheck
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 Getting the specific type of a variable or expression can be done with `typeof` or `instanceof`. However, it's often more expressive to use the Remeda equivalent function
 

package/docs/rules/prefer-some.md

@@ -1,4 +1,8 @@
-# Prefer R.some
+# remeda/prefer-some
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When comparing the index of an item with an `findIndex` method, it can be more expressive to use `R.some`, when only the sole existence of a matching item is taken into account.
 

package/docs/rules/prefer-times.md

@@ -1,4 +1,8 @@
-# Prefer R.times
+# remeda/prefer-times
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 When using `R.map` in which the iteratee does not have any arguments, it's better to use `R.times`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-remeda",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "author": "Andrea Pontrandolfo <andrea.pontra@gmail.com>",
   "description": "ESLint plugin for Remeda library.",
   "type": "module",
@@ -16,6 +16,8 @@
     "attw": "attw --pack .",
     "qa": "pnpm typecheck && pnpm test && pnpm knip && pnpm publint && attw",
     "nuke": "rm -rf node_modules pnpm-lock.yaml",
+    "update:eslint-docs": "eslint-doc-generator",
+    "lint:eslint-docs": "pnpm update:eslint-docs -- --check",
     "semantic-release": "pnpm build && semantic-release"
   },
   "files": [
@@ -48,7 +50,8 @@
     "eslint": "9.10.0",
     "eslint-config-sheriff": "^21.2.0",
     "eslint-define-config": "^2.1.0",
-    "eslint-plugin-eslint-plugin": "^6.2.0",
+    "eslint-doc-generator": "^2.1.2",
+    "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-vitest-rule-tester": "^0.3.3",
     "knip": "^5.29.1",
     "prettier": "^3.3.2",