eslint-plugin-remeda 1.5.0 → 1.7.0

package/docs/rules/prefer-has-atleast.md

@@ -0,0 +1,89 @@
+# remeda/prefer-has-atleast
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+When checking if an array has at least a certain number of elements, it is more expressive to use `R.hasAtLeast` instead of comparing the array's length with a number.
+
+Additionally, when checking if an array is not empty, it's better to use `R.hasAtLeast(data, 1)` instead of negated `R.isEmpty(data)` patterns (`!R.isEmpty(data)`) because the TypeScript type narrowing works better with `hasAtLeast`.
+
+## Rule Details
+
+The following patterns are considered warnings:
+
+```js
+// Array length comparisons
+if (array.length >= 3) {
+  // ...
+}
+
+if (array.length > 2) {
+  // ...
+}
+
+if (3 <= array.length) {
+  // ...
+}
+
+if (2 < array.length) {
+  // ...
+}
+
+// Negated isEmpty patterns (problematic for TypeScript type narrowing)
+if (!R.isEmpty(array)) {
+  // TypeScript won't narrow the array type here
+}
+
+if (R.isEmpty(array) === false) {
+  // Same issue with type narrowing
+}
+
+if (R.isEmpty(array) !== true) {
+  // Same issue with type narrowing
+}
+```
+
+The following patterns are not considered warnings:
+
+```js
+// Using hasAtLeast
+if (R.hasAtLeast(array, 3)) {
+  // ...
+}
+
+// For non-empty checks, use hasAtLeast with 1
+if (R.hasAtLeast(array, 1)) {
+  // TypeScript correctly narrows the type here
+}
+
+// Other length comparisons
+if (array.length === 3) {
+  // ...
+}
+
+if (array.length < 3) {
+  // ...
+}
+
+if (array.length <= 3) {
+  // ...
+}
+
+// Regular isEmpty checks are fine
+if (R.isEmpty(array)) {
+  // ...
+}
+```
+
+## Type Safety Improvement
+
+From Remeda documentation:
+
+> "This guard [isEmpty] doesn't work negated because of typescript limitations! If you need to check that an array is not empty, use R.hasAtLeast(data, 1) and not !R.isEmpty(data). For strings and objects there's no way in typescript to narrow the result to a non-empty type."
+
+Using `R.hasAtLeast(array, 1)` instead of `!R.isEmpty(array)` improves type safety because TypeScript can properly narrow the array type to a non-empty array, which helps prevent "possibly undefined" errors when accessing array elements.
+
+## When Not To Use It
+
+If you do not want to enforce using `R.hasAtLeast` or prefer the explicit array length comparison, you should not use this rule. However, consider enabling it at least for the negated `isEmpty` patterns to improve type safety.

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "eslint-plugin-remeda",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "author": "Andrea Pontrandolfo <andrea.pontra@gmail.com>",
   "description": "ESLint plugin for Remeda library.",
   "type": "module",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsup",
+    "build": "tsdown",
     "typecheck": "tsc",
     "lint": "eslint",
     "knip": "knip",
-    "publint": "publint",
     "test:watch": "vitest --ui",
     "test": "vitest run",
     "attw": "attw --pack .",
-    "qa": "pnpm typecheck && pnpm test && pnpm knip && pnpm publint && attw",
+    "qa": "pnpm typecheck && pnpm test && pnpm knip && attw",
     "nuke": "rm -rf node_modules pnpm-lock.yaml",
     "update:eslint-docs": "eslint-doc-generator",
     "lint:eslint-docs": "pnpm update:eslint-docs -- --check",
@@ -22,14 +21,21 @@
   },
   "files": [
     "README.md",
+    "LICENSE",
     "dist",
     "docs"
   ],
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": "./dist/index.js",
-      "default": "./dist/index.cjs"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "require": "./dist/index.cjs"
+      }
     }
   },
   "repository": {
@@ -42,24 +48,26 @@
     "eslint": ">=9.0.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.15.4",
+    "@arethetypeswrong/cli": "^0.17.4",
+    "@sherifforg/cli": "^8.2.0",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^20.14.9",
-    "@vitest/coverage-v8": "^2.0.3",
-    "@vitest/ui": "^2.0.3",
-    "eslint": "9.10.0",
-    "eslint-config-sheriff": "^21.2.0",
-    "eslint-define-config": "^2.1.0",
+    "@types/node": "^22.14.0",
+    "@typescript-eslint/utils": "^8.29.0",
+    "@vitest/coverage-v8": "^3.1.1",
+    "@vitest/ui": "^3.1.1",
+    "eslint": "9.24.0",
+    "eslint-config-sheriff": "^27.0.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",
+    "eslint-vitest-rule-tester": "^2.2.0",
+    "knip": "^5.49.0",
+    "lodash-es": "^4.17.21",
     "prettier": "^3.3.2",
-    "publint": "^0.2.10",
+    "publint": "^0.3.10",
     "semantic-release": "^24.0.0",
-    "tsup": "^8.2.4",
+    "tsdown": "^0.9.1",
     "typescript": "^5.5.2",
-    "vitest": "^2.0.3"
+    "vitest": "^3.1.1"
   },
   "engines": {
     "node": ">=20"
@@ -78,7 +86,5 @@
     "fp"
   ],
   "license": "MIT",
-  "dependencies": {
-    "lodash-es": "^4.17.21"
-  }
+  "sideEffects": false
 }