zeiger-eslint-plugin 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,8 @@
 # zeiger-eslint-plugin
 
-ESLint plugin for [Zeiger](https://github.com/DNepovim/zeiger) - ensures proper usage of Zeiger hooks with dependency arrays.
+ESLint plugin for [Zeiger](https://www.npmjs.com/package/zeiger) - ensures proper usage of Zeiger hooks with dependency arrays.
+
+Zeiger is a library for creating memoized collection item selectors for [Zustand](https://github.com/pmndrs/zustand) that eliminates unnecessary re-renders. This ESLint plugin helps you use Zeiger correctly by catching common mistakes with dependency arrays.
 
 ## Installation
 
@@ -86,6 +88,34 @@ return (
 );
 ```
 
+## Autofix
+
+The plugin supports automatic fixing of unused dependencies. When you run ESLint with the `--fix` flag, it will automatically remove unused properties from dependency arrays:
+
+```bash
+eslint --fix .
+```
+
+**Example:**
+
+```tsx
+// Before
+const user = useUserPointer('1', ['firstName', 'surname', 'email']);
+return (
+  <div>
+    {user?.firstName} - {user?.email}
+  </div>
+);
+
+// After autofix
+const user = useUserPointer('1', ['firstName', 'email']);
+return (
+  <div>
+    {user?.firstName} - {user?.email}
+  </div>
+);
+```
+
 ## Why This Plugin?
 
 Zeiger hooks use dependency arrays to specify which properties to subscribe to. This plugin helps you:
@@ -93,6 +123,7 @@ Zeiger hooks use dependency arrays to specify which properties to subscribe to.
 - **Avoid unnecessary subscriptions** - Catch unused properties in dependency arrays
 - **Prevent empty arrays** - Ensure you're always subscribing to at least one property
 - **Maintain code quality** - Keep your Zeiger hooks clean and efficient
+- **Automatic fixes** - Remove unused dependencies with ESLint's autofix feature
 
 ## License
 

package/dist/index.cjs

@@ -29,6 +29,7 @@ __webpack_require__.d(__webpack_exports__, {
 const rule = {
     meta: {
         type: 'problem',
+        fixable: 'code',
         docs: {
             description: 'Ensure zeiger hook dependency arrays are not empty and all dependencies are used'
         },
@@ -145,19 +146,34 @@ const rule = {
                 const depsArg = callNode.arguments.length > 0 ? callNode.arguments[callNode.arguments.length - 1] : null;
                 if (depsArg && 'ArrayExpression' === depsArg.type) {
                     const arrayNode = depsArg;
+                    const unusedDeps = [];
                     for(let i = 0; i < deps.length; i++){
                         const dep = deps[i];
                         if (!usedProperties.has(dep)) {
                             const depElement = arrayNode.elements[i];
-                            if (depElement) context.report({
-                                node: depElement,
-                                messageId: 'unusedDep',
-                                data: {
-                                    property: dep
-                                }
+                            if (depElement) unusedDeps.push({
+                                element: depElement,
+                                index: i,
+                                property: dep
                             });
                         }
                     }
+                    if (unusedDeps.length > 0) {
+                        const usedDeps = deps.filter((dep)=>usedProperties.has(dep));
+                        for (const { element, property } of unusedDeps)context.report({
+                            node: element,
+                            messageId: 'unusedDep',
+                            data: {
+                                property
+                            },
+                            fix (fixer) {
+                                if (0 === usedDeps.length) return null;
+                                const arrayText = usedDeps.map((dep)=>`'${dep}'`).join(', ');
+                                const newArrayText = `[${arrayText}]`;
+                                return fixer.replaceText(depsArg, newArrayText);
+                            }
+                        });
+                    }
                 }
             }
         };

package/dist/index.js

@@ -1,6 +1,7 @@
 const rule = {
     meta: {
         type: 'problem',
+        fixable: 'code',
         docs: {
             description: 'Ensure zeiger hook dependency arrays are not empty and all dependencies are used'
         },
@@ -117,19 +118,34 @@ const rule = {
                 const depsArg = callNode.arguments.length > 0 ? callNode.arguments[callNode.arguments.length - 1] : null;
                 if (depsArg && 'ArrayExpression' === depsArg.type) {
                     const arrayNode = depsArg;
+                    const unusedDeps = [];
                     for(let i = 0; i < deps.length; i++){
                         const dep = deps[i];
                         if (!usedProperties.has(dep)) {
                             const depElement = arrayNode.elements[i];
-                            if (depElement) context.report({
-                                node: depElement,
-                                messageId: 'unusedDep',
-                                data: {
-                                    property: dep
-                                }
+                            if (depElement) unusedDeps.push({
+                                element: depElement,
+                                index: i,
+                                property: dep
                             });
                         }
                     }
+                    if (unusedDeps.length > 0) {
+                        const usedDeps = deps.filter((dep)=>usedProperties.has(dep));
+                        for (const { element, property } of unusedDeps)context.report({
+                            node: element,
+                            messageId: 'unusedDep',
+                            data: {
+                                property
+                            },
+                            fix (fixer) {
+                                if (0 === usedDeps.length) return null;
+                                const arrayText = usedDeps.map((dep)=>`'${dep}'`).join(', ');
+                                const newArrayText = `[${arrayText}]`;
+                                return fixer.replaceText(depsArg, newArrayText);
+                            }
+                        });
+                    }
                 }
             }
         };

package/dist/rules/zeiger-deps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zeiger-deps.d.ts","sourceRoot":"","sources":["../../src/rules/zeiger-deps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA2VhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"zeiger-deps.d.ts","sourceRoot":"","sources":["../../src/rules/zeiger-deps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA0XhB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/package.json

@@ -4,8 +4,9 @@
   "homepage": "https://github.com/DNepovim/zeiger",
   "repository": "https://github.com/DNepovim/zeiger",
   "author": "Dominik Bláha <iam@dominikblaha.cz>",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
+  "license": "MIT",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",