eslint-plugin-function-rule 0.0.5 → 0.0.7

package/README.md

@@ -17,9 +17,8 @@ npm install --save-dev eslint-plugin-function-rule
 ### Write function rules inline
 
 ```js
-// eslint.config.js
+// eslint.config.ts
 
-// @ts-check
 import eslintJs from "@eslint/js";
 import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
 import functionRule from "eslint-plugin-function-rule";
@@ -66,19 +65,34 @@ export default defineConfig(
 );
 ```
 
-### Import function rules from packages
+### Import function rules from modules
 
 ```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";
+
+// Define and document function rule options
+export interface noDebuggerOptions {
+  /**
+   * @deprecated Use bar instead
+   */
+  foo: string
+  bar: string
+}
+
+// Define and document function rule
 /**
- * Remove console methods from code
+ * Remove debugger from code
+ *
  * @param options The rule options
  * @returns RuleFunction
  */
-export function noDebugger(options?: unknown): RuleDefinition["create"] {
+export function noDebugger(options?: noDebuggerOptions): RuleDefinition["create"] {
   return (context) => {
-    return {
+    return defineRuleVisitor({
       DebuggerStatement(node) {
         context.report({
           node,
@@ -89,20 +103,18 @@ export function noDebugger(options?: unknown): RuleDefinition["create"] {
           },
         });
       },
-    } satisfies RuleListener;
+    });
   };
 }
-
 ```
 
 ```js
-// eslint.config.js
+// Import and use function rule
 
-// @ts-check
 // ...
 import { noDebugger } from "./noDebugger.ts";
 
-const noDebuggerRule = noDebugger({/* rule options */});
+const noDebuggerRule = noDebugger({ bar: "pass rule options" });
 
 export default defineConfig(
   // ...
@@ -113,7 +125,9 @@ export default defineConfig(
     },
     plugins: {
       "function-rule": functionRule((context) => {
-        noDebuggerRule(context);
+        return {
+          ...noDebuggerRule(context)
+        }
       }),
     },
   },

package/dist/index.d.ts

@@ -1,28 +1,17 @@
-import * as _eslint_core0 from "@eslint/core";
-import { RuleDefinition } from "@eslint/core";
+import { Rule } from "eslint";
 
 //#region index.d.ts
-declare function functionRule(create: RuleDefinition["create"]): {
+declare function defineRuleListener(ruleListener: Rule.RuleListener): Rule.RuleListener;
+declare function functionRule(create: Rule.RuleModule["create"]): {
   readonly rules: {
     readonly "function-rule": {
       readonly meta: {
         readonly fixable: "code";
         readonly hasSuggestions: true;
       };
-      readonly create: (context: _eslint_core0.RuleContext<{
-        LangOptions: _eslint_core0.LanguageOptions;
-        Code: _eslint_core0.SourceCode<{
-          LangOptions: _eslint_core0.LanguageOptions;
-          RootNode: unknown;
-          SyntaxElementWithLoc: unknown;
-          ConfigNode: unknown;
-        }>;
-        RuleOptions: unknown[];
-        Node: unknown;
-        MessageIds: string;
-      }>) => _eslint_core0.RuleVisitor;
+      readonly create: (context: Rule.RuleContext) => Rule.RuleListener;
     };
   };
 };
 //#endregion
-export { functionRule as default };
+export { functionRule as default, defineRuleListener };

package/dist/index.js

@@ -1,4 +1,10 @@
 //#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(create) {
 	return { rules: { "function-rule": {
 		meta: {
@@ -10,4 +16,4 @@ function functionRule(create) {
 }
 
 //#endregion
-export { functionRule as default };
+export { functionRule as default, defineRuleListener };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-function-rule",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "license": "MIT",
   "sideEffects": false,
   "type": "module",
@@ -21,6 +21,7 @@
     "tsdown": "^0.16.1"
   },
   "peerDependencies": {
+    "eslint": "^9.39.1",
     "typescript": "^5"
   },
   "scripts": {