eslint-plugin-function-rule 0.0.16 → 0.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 REL1CX
+Copyright (c) 2025 Rel1cx
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,7 +1,4 @@
-ESLint plugin to write custom rules with JavaScript functions.
-
-> [!WARNING]
-> This package is a work in progress and is not yet ready for production use.
+An ESLint plugin to write custom rules with JavaScript functions.
 
 ## Index
 
@@ -21,12 +18,12 @@ npm install --save-dev eslint-plugin-function-rule
 
 ## Write function rules inline
 
-```js
+```ts
 // eslint.config.ts
 
 import type { Rule } from "eslint";
-import { defineConfig } from "eslint/config";
 import { functionRule } from "eslint-plugin-function-rule";
+import { defineConfig } from "eslint/config";
 
 export default defineConfig(
   {
@@ -56,38 +53,38 @@ export default defineConfig(
 
 ## Or import function rules from modules
 
-```js
-// noDebugger.ts
+```ts
+// no-null.ts
 
 import type { Rule } from "eslint";
-import { functionRuleListener } from "eslint-plugin-function-rule";
-
-// Define and document function rule options
-export interface noDebuggerOptions {}
 
-// Define and document function rule
-export function noDebugger(options?: noDebuggerOptions) {
-    return (context: Rule.RuleContext): Rule.RuleListener => ({
-        DebuggerStatement(node) {
-            context.report({
-                node,
-                message: "Remove 'debugger' from code.",
-
-                fix(fixer) {
-                    return fixer.remove(node);
-                },
-            });
-        },
-    });
+export function noNull(options?: { enableAutoFix?: boolean; enableSuggest?: boolean }) {
+  const { enableAutoFix = false, enableSuggest = false } = options ?? {};
+  return (context: Rule.RuleContext): Rule.RuleListener => {
+    return {
+      Literal(node) {
+        if (node.raw !== "null" || node.parent.type !== "BinaryExpression") return;
+        function fix(fixer: Rule.RuleFixer) {
+          return fixer.replaceText(node, "undefined");
+        }
+        context.report({
+          node: node.parent,
+          message: "Avoid using 'null'; Use 'undefined' instead.",
+          ...enableAutoFix ? { fix } : {},
+          ...enableSuggest ? { suggest: [{ fix, desc: "Replace with 'undefined'." }] } : {},
+        });
+      },
+    };
+  };
 }
 ```
 
-```js
+```ts
 // eslint.config.ts
 
 import { functionRule } from "eslint-plugin-function-rule";
 import { defineConfig } from "eslint/config";
-import { noDebugger } from "./noDebugger.ts";
+import { noNull } from "./no-null.ts";
 
 export default defineConfig(
   {
@@ -96,7 +93,7 @@ export default defineConfig(
       "function-rule/function-rule": "error",
     },
     plugins: {
-      "function-rule": functionRule(noDebugger({/* pass rule options */})),
+      "function-rule": functionRule(noNull({ enableAutoFix: true })),
     },
   },
 );
@@ -104,7 +101,7 @@ export default defineConfig(
 
 ## Define multiple function rules with custom prefix
 
-```js
+```ts
 // eslint.config.ts
 
 import { functionRule } from "eslint-plugin-function-rule";
@@ -119,10 +116,28 @@ export default defineConfig(
     },
     plugins: {
       "custom-1": functionRule((context) => {
-        return {/* your won rule logic */};
+        return {
+          CallExpression(node) {
+            if (context.sourceCode.getText(node.callee) === "Date.now") {
+              context.report({
+                node,
+                message: "Don't use 'Date.now'.",
+              });
+            }
+          },
+        };
       }),
       "custom-2": functionRule((context) => {
-        return {/* your won rule logic */};
+        return {
+          CallExpression(node) {
+            if (context.sourceCode.getText(node.callee) === "Math.random") {
+              context.report({
+                node,
+                message: "Don't use 'Math.random()'.",
+              });
+            }
+          },
+        };
       }),
     },
   },

package/dist/index.d.ts

@@ -2,7 +2,20 @@ import { Plugin } from "@eslint/core";
 import { Rule } from "eslint";
 
 //#region src/index.d.ts
+
+/**
+ * Wraps an ESLint rule's create function as an ESLint Plugin with a single rule named "function-rule".
+ * The rule is fixable and supports suggestions.
+ * @param create The rule's listener create function.
+ * @returns ESLint Plugin object with "function-rule".
+ */
 declare function functionRule(create: Rule.RuleModule["create"]): Plugin;
+/**
+ * Returns a copy of the given rule listener,
+ * but prepends an increasing number of spaces to each event key name for uniqueness.
+ * @param ruleListener ESLint rule listener object (mapping event name to handler).
+ * @returns New rule listener object with modified keys for uniqueness.
+ */
 declare function defineRuleListener(ruleListener: Rule.RuleListener): Rule.RuleListener;
 //#endregion
 export { defineRuleListener, functionRule };

package/dist/index.js

@@ -1,4 +1,10 @@
 //#region src/index.ts
+/**
+* Wraps an ESLint rule's create function as an ESLint Plugin with a single rule named "function-rule".
+* The rule is fixable and supports suggestions.
+* @param create The rule's listener create function.
+* @returns ESLint Plugin object with "function-rule".
+*/
 function functionRule(create) {
 	return { rules: { "function-rule": {
 		meta: {
@@ -9,6 +15,12 @@ function functionRule(create) {
 	} } };
 }
 let id = 1;
+/**
+* Returns a copy of the given rule listener,
+* but prepends an increasing number of spaces to each event key name for uniqueness.
+* @param ruleListener ESLint rule listener object (mapping event name to handler).
+* @returns New rule listener object with modified keys for uniqueness.
+*/
 function defineRuleListener(ruleListener) {
 	const listener = {};
 	for (const key of Object.keys(ruleListener)) listener[" ".repeat(id++) + key] = ruleListener[key];

package/package.json

@@ -1,39 +1,44 @@
 {
   "name": "eslint-plugin-function-rule",
-  "version": "0.0.16",
+  "version": "0.1.0",
+  "description": "An ESLint plugin to write custom rules with JavaScript functions.",
+  "homepage": "https://github.com/Rel1cx/dx",
+  "bugs": {
+    "url": "https://github.com/Rel1cx/dx/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rel1cx/dx.git"
+  },
   "license": "MIT",
+  "author": "Rel1cx<rel1cx@proton.me>",
   "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
+  "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "package.json"
+    "./package.json"
   ],
-  "dependencies": {
-    "@eslint/core": "^1.0.0"
-  },
-  "devDependencies": {
-    "dprint": "^0.50.2",
-    "tsdown": "^0.16.4"
-  },
   "peerDependencies": {
-    "eslint": "^9.39.1",
-    "typescript": "^5"
+    "@eslint/core": "^1.0.0",
+    "eslint": "^9.39.1"
+  },
+  "engines": {
+    "node": ">=20.0.0"
   },
   "scripts": {
-    "build": "tsdown",
-    "format:check": "dprint check",
-    "format:write": "dprint fmt",
-    "type-check": "tsc --noEmit"
+    "build": "tsdown --dts-resolve",
+    "build:docs": "typedoc",
+    "lint:publish": "publint",
+    "lint:ts": "tsc --noEmit"
   }
 }