@sabzidev/eslint-rules 1.0.4 → 1.0.6

package/README.md

@@ -9,7 +9,9 @@ A collection of custom ESLint rules for improving code quality, consistency, and
 <div align="center">
   <img src="https://img.shields.io/npm/dm/@sabzidev/eslint-rules?style=flat-square&&color=16A34A&label=DOWNLOADS" alt="DOWNLOADS" />
   <img src="https://img.shields.io/npm/v/@sabzidev/eslint-rules?style=flat-square&color=16A34A&label=VERSION" alt="VERSION" />
+
   <br />
+
   <img src="./docs/images/logo.webp" alt="SabziDev logo" height="300" width="70%" />
 
 [GITHUB](https://github.com/SabziDev/eslint-rules) | [NPM](https://npmjs.com/package/@sabzidev/eslint-rules)
@@ -24,7 +26,7 @@ A collection of custom ESLint rules for improving code quality, consistency, and
 
 ---
 
-## 📦 Installation
+## 🚀📦 Installation & Usage
 
 Install the package as a development dependency:
 
@@ -32,11 +34,7 @@ Install the package as a development dependency:
 pnpm i -D @sabzidev/eslint-rules
 ```
 
----
-
-## 🚀 Usage
-
-Choose **one** of the following configuration methods for your existing `eslint.config.js` file:
+Choose **one** of the following configuration methods for your `eslint.config.js` file:
 
 ### ● Recommended Configuration
 
@@ -52,7 +50,7 @@ export default defineConfig([
 ]);
 ```
 
-This enables all rules included in the recommended configuration with their predefined severity levels.
+This enables all recommended rules with their predefined severity levels.
 
 ### ● Custom Configuration
 
@@ -84,11 +82,19 @@ export default defineConfig([
 
 ---
 
-## ⭐ Recommended Tooling Setup
+## ⭐ Recommended ESLint & Prettier Setup
+
+Install the required dependencies:
+
+```bash
+pnpm i -D eslint prettier @fullstacksjs/eslint-config @sabzidev/eslint-rules eslint-plugin-sonarjs eslint-plugin-unicorn
+```
+
+For a comprehensive code-quality setup, combine `ESLint`, `Prettier`, [`@fullstacksjs/eslint-config`](https://npmjs.com/package/@fullstacksjs/eslint-config), [`@sabzidev/eslint-rules`](https://npmjs.com/package/@sabzidev/eslint-rules), [`eslint-plugin-sonarjs`](https://npmjs.com/package/eslint-plugin-sonarjs), and [`eslint-plugin-unicorn`](https://npmjs.com/package/eslint-plugin-unicorn).
 
-For a more comprehensive linting setup, combine `@sabzidev/eslint-rules` with [`@fullstacksjs/eslint-config`](https://www.npmjs.com/package/@fullstacksjs/eslint-config), [`eslint-plugin-sonarjs`](https://www.npmjs.com/package/eslint-plugin-sonarjs), and [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn).
+This setup combines code formatting, code-quality checks, bug detection, maintainability rules, and custom ESLint rules.
 
-This combination brings together code-quality rules, bug detection, maintainability checks, and custom linting rules.
+This setup combines code-quality rules, bug detection, maintainability checks, and custom linting rules.
 
 **Configuration for `eslint.config.js`:**
 
@@ -108,28 +114,39 @@ const baseRules = {
   eqeqeq: ["error", "always"],
   "no-console": "warn",
 };
+
 const plugins = [
   sabzidev.configs.recommended,
   sonarjs.configs.recommended,
   unicorn.configs.recommended,
 ];
+
 const pluginsRules = {
   "unicorn/filename-case": "off",
-  "unicorn/prefer-global-this": "off",
-  "unicorn/name-replacements": "off",
-  "unicorn/no-array-sort": "off",
+  "unicorn/name-replacements": [
+    "error",
+    {
+      replacements: {
+        prop: false,
+        props: false,
+        param: false,
+        params: false,
+        ref: false,
+        refs: false,
+        prev: false,
+        e: false,
+        res: false,
+        err: false,
+      },
+    },
+  ],
   "unicorn/no-null": "off",
+  "unicorn/prefer-global-this": "off",
   "unicorn/default-export-style": "off",
-
-  "jsx-a11y/click-events-have-key-events": "off",
-  "jsx-a11y/no-noninteractive-element-interactions": "off",
 };
 
 const config = defineConfig(
-  {
-    tailwind: { entryPoint: "./src/input.css" },
-    rules: baseRules,
-  },
+  { rules: baseRules, tailwind: { entryPoint: "./src/input.css" } },
 
   plugins,
   { rules: pluginsRules },
@@ -138,23 +155,23 @@ const config = defineConfig(
 export default config;
 ```
 
-**Note:** Customize the rules to match your project's requirements and verify compatibility with your installed plugin versions.
+**Note:** Adjust the rules to suit your project and ensure compatibility with your installed plugin versions.
 
 ---
 
 ## 📋 Available Rules
 
-| Rule                                     | Description                                  |
-| :--------------------------------------- | :------------------------------------------- |
-| `merge-duplicate-id-and-classname-props` | Merges duplicate `id` and `className` props. |
-| `merge-exports`                          | Merges or organizes export declarations.     |
-| `no-invalid-id-and-classname-value`      | Detects invalid `id` and `className` values. |
-| `no-useless-empty-type`                  | Detects unnecessary empty types.             |
-| `no-useless-template-literal`            | Detects unnecessary template literals.       |
-| `padding-before-jump-statement`          | Enforces padding before jump statements.     |
-| `sort-comments`                          | Sorts comments.                              |
-| `sort-jsx-props`                         | Sorts JSX props.                             |
-| `sort-object-props`                      | Sorts object properties.                     |
+| Rule                                     | Description                              |
+| :--------------------------------------- | :--------------------------------------- |
+| `merge-duplicate-id-and-classname-props` | Merges duplicate id and className props. |
+| `merge-exports`                          | Merges or organizes export declarations. |
+| `no-invalid-id-and-classname-value`      | Detects invalid id and className values. |
+| `no-useless-empty-type`                  | Detects unnecessary empty types.         |
+| `no-useless-template-literal`            | Detects unnecessary template literals.   |
+| `padding-before-jump-statement`          | Enforces padding before jump statements. |
+| `sort-comments`                          | Sorts comments.                          |
+| `sort-jsx-props`                         | Sorts JSX props.                         |
+| `sort-object-props`                      | Sorts object properties.                 |
 
 ---
 

package/dist/index.js

@@ -1,11 +1,6 @@
 var e = {
 	name: "@sabzidev/eslint-rules",
 	description: "A collection of ESLint rules for better code quality, consistency, and maintainability.",
-	repository: {
-		type: "git",
-		url: "https://github.com/SabziDev/eslint-rules"
-	},
-	license: "MIT",
 	keywords: [
 		"SabziDev",
 		"eslint",
@@ -16,8 +11,13 @@ var e = {
 		"linting",
 		"developer-tools"
 	],
+	repository: {
+		type: "git",
+		url: "https://github.com/SabziDev/eslint-rules"
+	},
+	license: "MIT",
 	author: "Abolfazl Sabzmohammadi <SabziDev@gmail.com> (https://Sabzi.Dev)",
-	version: "1.0.4",
+	version: "1.0.6",
 	type: "module",
 	main: "./dist/index.js",
 	exports: "./dist/index.js",
@@ -356,10 +356,11 @@ var e = {
 			});
 		} };
 	}
-}, l = /* @__PURE__ */ "children.key.id.ref.data.title.desc.htmlFor.type.inputMode.name.value.placeholder.autoComplete.min.max.minLength.maxLength.src.alt.loading.poster.preload.controls.href.target.rel.to.replace.viewTransition".split("."), u = [
+}, l = /* @__PURE__ */ "prop.props.children.param.params.key.id.ref.data.title.desc.htmlFor.type.inputMode.name.value.placeholder.autoComplete.min.max.minLength.maxLength.src.alt.loading.poster.preload.controls.href.target.rel.to.replace.viewTransition".split("."), u = [
 	"onClick",
 	"onChange",
-	"onKeyUp"
+	"onKeyUp",
+	"onKeyDown"
 ], d = {
 	"merge-duplicate-id-and-classname-props": t,
 	"merge-exports": n,
@@ -412,7 +413,7 @@ var e = {
 			} };
 		}
 	},
-	"sort-object-props": {
+	"sort-props": {
 		meta: {
 			type: "suggestion",
 			fixable: "code",
@@ -432,16 +433,10 @@ var e = {
 				let t = l.flatMap((t) => e.filter((e) => a(e) === t)), o = e.filter((e) => {
 					let t = a(e);
 					return !n.has(t) && !r(t) && !["className", "style"].includes(t);
-				}), s = e.filter((e) => {
-					let t = a(e);
-					return r(t);
-				}).sort((e, t) => {
+				}), s = e.filter((e) => r(a(e))).sort((e, t) => {
 					let n = i(a(e)), r = i(a(t));
 					return n === 999 && r === 999 ? 0 : n - r;
-				}), c = e.filter((e) => {
-					let t = a(e);
-					return ["className", "style"].includes(t);
-				}).sort((e, t) => {
+				}), c = e.filter((e) => ["className", "style"].includes(a(e))).sort((e, t) => {
 					let n = a(e), r = a(t);
 					return n === "className" && r === "style" ? -1 : +(n === "style" && r === "className");
 				});
@@ -453,57 +448,68 @@ var e = {
 				];
 			}, d = (e) => {
 				let t = [], n = [];
-				for (let r of e) if (o(r)) {
-					if (n.length > 0) {
-						let e = c(n);
-						t.push(...e), n = [];
-					}
-					t.push(r);
-				} else n.push(r);
-				if (n.length > 0) {
-					let e = c(n);
-					t.push(...e);
-				}
-				return t;
+				for (let r of e) o(r) ? (n.length > 0 && (t.push(...c(n)), n = []), t.push(r)) : n.push(r);
+				return n.length > 0 && t.push(...c(n)), t;
 			}, f = (e) => {
 				if (e.length <= 1) return e;
 				let t = e.filter((e) => !o(e) && s(e)), n = e.filter((e) => !t.includes(e));
 				return [...c(t), ...n];
-			}, p = (e, t) => {
-				if (e.length !== t.length) return !0;
-				for (let [n, r] of e.entries()) if (r !== t[n]) return !0;
-				return !1;
-			}, m = (e) => `{ ${e.map((e) => t.getText(e)).join(", ")} }`, h = (e) => e.map((e) => t.getText(e)).join("\n"), g = (n, r) => {
-				let { properties: i } = n;
-				if (!i || i.length <= 1) return;
-				let a = d(i);
-				if (!p(i, a)) return;
-				let o = i[0], s = i.at(-1), c = o.range[0], l = s.range[1];
+			}, p = (e, t) => e.length !== t.length || e.some((e, n) => e !== t[n]), m = (e) => `{ ${e.map((e) => t.getText(e)).join(", ")} }`, h = (e) => e.map((e) => t.getText(e)).join("\n"), g = (t, n, r, i, a) => {
+				if (!p(n, r)) return;
+				let o = n[0], s = n.at(-1);
 				e.report({
-					node: n,
-					messageId: r,
+					node: t,
+					messageId: i,
 					fix(e) {
-						let n = a.map((e) => t.getText(e)).join(", ");
-						return e.replaceTextRange([c, l], n);
+						let t = a(r);
+						return e.replaceTextRange([o.range[0], s.range[1]], t);
 					}
 				});
-			}, _ = (e) => {
-				let { params: t } = e;
-				if (t && t.length !== 0) for (let e of t) e.type === "ObjectPattern" && g(e, "wrongParams");
-			}, v = (t) => {
-				let n = t.body ?? t.members;
-				if (!n || n.length <= 1) return;
-				let r = f(n);
-				if (!p(n, r)) return;
-				let i = n[0], a = n.at(-1), o = i.range[0], s = a.range[1];
+			}, _ = (e, n) => {
+				let { properties: r } = e;
+				if (!r || r.length <= 1) return;
+				let i = d(r);
+				g(e, r, i, n, (e) => e.map((e) => t.getText(e)).join(", "));
+			}, v = (n) => {
+				let { params: a } = n;
+				if (!a || a.length === 0) return;
+				for (let e of a) e.type === "ObjectPattern" && _(e, "wrongParams");
+				if (a.length <= 1 || a.some((e) => e.type !== "Identifier")) return;
+				let o = (e) => {
+					let t = l.indexOf(e);
+					return t === -1 ? r(e) ? {
+						category: 2,
+						priority: i(e)
+					} : e === "className" ? {
+						category: 3,
+						priority: 0
+					} : {
+						category: e === "style" ? 4 : 1,
+						priority: 0
+					} : {
+						category: 0,
+						priority: t
+					};
+				}, s = a.map((e, t) => ({
+					param: e,
+					index: t,
+					...o(e.name)
+				})).sort((e, t) => e.category === t.category ? e.priority === t.priority ? e.index - t.index : e.priority - t.priority : e.category - t.category).map(({ param: e }) => e);
+				if (!p(a, s)) return;
+				let c = a[0], u = a.at(-1);
 				e.report({
-					node: t,
-					messageId: "wrongTypeProperties",
+					node: n,
+					messageId: "wrongParams",
 					fix(e) {
-						let t = h(r);
-						return e.replaceTextRange([o, s], t);
+						let n = s.map((e) => t.getText(e)).join(", ");
+						return e.replaceTextRange([c.range[0], u.range[1]], n);
 					}
 				});
+			}, y = (e) => {
+				let t = e.body ?? e.members;
+				if (!t || t.length <= 1) return;
+				let n = f(t);
+				g(e, t, n, "wrongTypeProperties", h);
 			};
 			return {
 				ObjectExpression(t) {
@@ -514,26 +520,23 @@ var e = {
 						node: t,
 						messageId: "wrongOrder",
 						fix(e) {
-							let n = m(r);
-							return e.replaceText(t, n);
+							return e.replaceText(t, m(r));
 						}
 					});
 				},
 				ObjectPattern(e) {
-					g(e, "wrongDestructure");
-				},
-				TSTypeLiteral(e) {
-					v(e);
-				},
-				TSInterfaceBody(e) {
-					v(e);
-				},
-				TSTypeAliasDeclaration(e) {
-					e.typeAnnotation?.type === "TSTypeLiteral" && v(e.typeAnnotation);
+					_(e, "wrongDestructure");
 				},
-				FunctionDeclaration: _,
-				FunctionExpression: _,
-				ArrowFunctionExpression: _
+				TSTypeLiteral: y,
+				TSInterfaceBody: y,
+				FunctionDeclaration: v,
+				FunctionExpression: v,
+				ArrowFunctionExpression: v,
+				TSDeclareFunction: v,
+				TSFunctionType: v,
+				TSCallSignatureDeclaration: v,
+				TSConstructSignatureDeclaration: v,
+				TSMethodSignature: v
 			};
 		}
 	}

package/package.json

@@ -1,11 +1,6 @@
 {
   "name": "@sabzidev/eslint-rules",
   "description": "A collection of ESLint rules for better code quality, consistency, and maintainability.",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/SabziDev/eslint-rules"
-  },
-  "license": "MIT",
   "keywords": [
     "SabziDev",
     "eslint",
@@ -16,8 +11,13 @@
     "linting",
     "developer-tools"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SabziDev/eslint-rules"
+  },
+  "license": "MIT",
   "author": "Abolfazl Sabzmohammadi <SabziDev@gmail.com> (https://Sabzi.Dev)",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "type": "module",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",