eslint-plugin-function-rule 0.0.9 → 0.0.11

package/README.md

@@ -21,7 +21,7 @@ npm install --save-dev eslint-plugin-function-rule
 
 import eslintJs from "@eslint/js";
 import type { Rule } from "eslint";
-import functionRule from "eslint-plugin-function-rule";
+import { defineRule } from "eslint-plugin-function-rule";
 import { defineConfig } from "eslint/config";
 import tseslint from "typescript-eslint";
 
@@ -43,10 +43,10 @@ export default defineConfig(
   {
     files: ["**/*.ts"],
     rules: {
-      "function-rule/v1": "error",
+      "function-rule/function-rule": "error",
     },
     plugins: {
-      "function-rule": functionRule("v1", (context) => {
+      "function-rule": defineRule((context) => {
         return {
           DebuggerStatement(node) {
             context.report({
@@ -93,10 +93,13 @@ export function noDebugger(options?: noDebuggerOptions) {
 }
 ```
 
+### Define function rule with default prefix
+
 ```js
 // eslint.config.ts
 
 // ...
+import { defineRule } from "eslint-plugin-function-rule";
 import { noDebugger } from "./noDebugger.ts";
 
 export default defineConfig(
@@ -104,10 +107,39 @@ export default defineConfig(
   {
     files: ["**/*.ts"],
     rules: {
-      "no-debugger/v1": "error",
+      "function-rule/function-rule": "error",
     },
     plugins: {
-      "no-debugger": functionRule("v1", noDebugger({ /* pass rule options */ })),
+      "function-rule": defineRule(noDebugger({ /* pass rule options */ })),
+    },
+  },
+);
+```
+
+### Define function rule with custom prefix
+
+```js
+// eslint.config.ts
+
+// ...
+import { defineRule } from "eslint-plugin-function-rule";
+import { noDebugger } from "./noDebugger.ts";
+
+export default defineConfig(
+  // ...
+  {
+    files: ["**/*.ts"],
+    rules: {
+      "no-debugger/function-rule": "error",
+
+      "custom/function-rule": "error",
+    },
+    plugins: {
+      "no-debugger": defineRule(noDebugger({ /* pass rule options */ })),
+
+      custom: defineRule((context) => {
+        return { /* your won rule logic */ }
+      }),
     },
   },
 );

package/dist/index.d.ts

@@ -1,10 +1,9 @@
 import { Rule } from "eslint";
 
 //#region index.d.ts
-declare function defineRuleListener(ruleListener: Rule.RuleListener): Rule.RuleListener;
-declare function functionRule(name: string, create: Rule.RuleModule["create"]): {
+declare function defineRule(create: Rule.RuleModule["create"]): {
   readonly rules: {
-    readonly [name]: {
+    readonly "function-rule": {
       readonly meta: {
         readonly fixable: "code";
         readonly hasSuggestions: true;
@@ -13,5 +12,6 @@ declare function functionRule(name: string, create: Rule.RuleModule["create"]):
     };
   };
 };
+declare function defineRuleListener(ruleListener: Rule.RuleListener): Rule.RuleListener;
 //#endregion
-export { defineRuleListener, functionRule };
+export { defineRule, defineRuleListener };

package/dist/index.js

@@ -1,12 +1,6 @@
 //#region index.ts
-const id = 0;
-function defineRuleListener(ruleListener) {
-	const listener = {};
-	for (const key of Object.keys(ruleListener)) listener[key + `[type!=${id}]`] = ruleListener[key];
-	return listener;
-}
-function functionRule(name, create) {
-	return { rules: { [name]: {
+function defineRule(create) {
+	return { rules: { "function-rule": {
 		meta: {
 			fixable: "code",
 			hasSuggestions: true
@@ -14,6 +8,12 @@ function functionRule(name, create) {
 		create
 	} } };
 }
+const id = 0;
+function defineRuleListener(ruleListener) {
+	const listener = {};
+	for (const key of Object.keys(ruleListener)) listener[key + `[type!=${id}]`] = ruleListener[key];
+	return listener;
+}
 
 //#endregion
-export { defineRuleListener, functionRule };
+export { defineRule, defineRuleListener };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-function-rule",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "license": "MIT",
   "sideEffects": false,
   "type": "module",