eslint-plugin-function-rule 0.0.7 → 0.0.9

package/README.md

@@ -20,7 +20,7 @@ npm install --save-dev eslint-plugin-function-rule
 // eslint.config.ts
 
 import eslintJs from "@eslint/js";
-import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
+import type { Rule } from "eslint";
 import functionRule 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/function-rule": "error",
+      "function-rule/v1": "error",
     },
     plugins: {
-      "function-rule": functionRule((context) => {
+      "function-rule": functionRule("v1", (context) => {
         return {
           DebuggerStatement(node) {
             context.report({
@@ -58,7 +58,7 @@ export default defineConfig(
               },
             });
           },
-        } satisfies RuleListener;
+        } satisfies Rule.RuleListener;
       }),
     },
   },
@@ -70,65 +70,44 @@ export default defineConfig(
 ```js
 // noDebugger.ts
 
-import type { RuleDefinition } from "@eslint/core";
-import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
-import { defineRuleVisitor } from "eslint-plugin-function-rule";
+import type { Rule } from "eslint";
+import { defineRuleListener } from "eslint-plugin-function-rule";
 
 // Define and document function rule options
-export interface noDebuggerOptions {
-  /**
-   * @deprecated Use bar instead
-   */
-  foo: string
-  bar: string
-}
+export interface noDebuggerOptions {}
 
 // Define and document function rule
-/**
- * Remove debugger from code
- *
- * @param options The rule options
- * @returns RuleFunction
- */
-export function noDebugger(options?: noDebuggerOptions): RuleDefinition["create"] {
-  return (context) => {
-    return defineRuleVisitor({
-      DebuggerStatement(node) {
-        context.report({
-          node,
-          message: "Remove 'debugger' from code.",
-
-          fix(fixer) {
-            return fixer.remove(node);
-          },
-        });
-      },
+export function noDebugger(options?: noDebuggerOptions) {
+    return (context: Rule.RuleContext) => defineRuleListener({
+        DebuggerStatement(node) {
+            context.report({
+                node,
+                message: "Remove 'debugger' from code.",
+
+                fix(fixer) {
+                    return fixer.remove(node);
+                },
+            });
+        },
     });
-  };
 }
 ```
 
 ```js
-// Import and use function rule
+// eslint.config.ts
 
 // ...
 import { noDebugger } from "./noDebugger.ts";
 
-const noDebuggerRule = noDebugger({ bar: "pass rule options" });
-
 export default defineConfig(
   // ...
   {
     files: ["**/*.ts"],
     rules: {
-      "function-rule/function-rule": "error",
+      "no-debugger/v1": "error",
     },
     plugins: {
-      "function-rule": functionRule((context) => {
-        return {
-          ...noDebuggerRule(context)
-        }
-      }),
+      "no-debugger": functionRule("v1", noDebugger({ /* pass rule options */ })),
     },
   },
 );

package/dist/index.d.ts

@@ -2,9 +2,9 @@ import { Rule } from "eslint";
 
 //#region index.d.ts
 declare function defineRuleListener(ruleListener: Rule.RuleListener): Rule.RuleListener;
-declare function functionRule(create: Rule.RuleModule["create"]): {
+declare function functionRule(name: string, create: Rule.RuleModule["create"]): {
   readonly rules: {
-    readonly "function-rule": {
+    readonly [name]: {
       readonly meta: {
         readonly fixable: "code";
         readonly hasSuggestions: true;
@@ -14,4 +14,4 @@ declare function functionRule(create: Rule.RuleModule["create"]): {
   };
 };
 //#endregion
-export { functionRule as default, defineRuleListener };
+export { defineRuleListener, functionRule };

package/dist/index.js

@@ -5,8 +5,8 @@ function defineRuleListener(ruleListener) {
 	for (const key of Object.keys(ruleListener)) listener[key + `[type!=${id}]`] = ruleListener[key];
 	return listener;
 }
-function functionRule(create) {
-	return { rules: { "function-rule": {
+function functionRule(name, create) {
+	return { rules: { [name]: {
 		meta: {
 			fixable: "code",
 			hasSuggestions: true
@@ -16,4 +16,4 @@ function functionRule(create) {
 }
 
 //#endregion
-export { functionRule as default, defineRuleListener };
+export { defineRuleListener, functionRule };

package/package.json

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