eslint-plugin-function-rule 0.0.13 → 0.0.14

package/README.md

@@ -24,34 +24,18 @@ npm install --save-dev eslint-plugin-function-rule
 ```js
 // eslint.config.ts
 
-import eslintJs from "@eslint/js";
 import type { Rule } from "eslint";
-import { defineRule } from "eslint-plugin-function-rule";
 import { defineConfig } from "eslint/config";
-import tseslint from "typescript-eslint";
+import { functionRule } from "eslint-plugin-function-rule";
 
 export default defineConfig(
-  {
-    files: ["**/*.ts", "**/*.tsx"],
-    extends: [
-      eslintJs.configs.recommended,
-      tseslint.configs.recommended,
-    ],
-    languageOptions: {
-      parser: tseslint.parser,
-      parserOptions: {
-        projectService: true,
-        tsconfigRootDir: import.meta.dirname,
-      },
-    },
-  },
   {
     files: ["**/*.ts"],
     rules: {
       "function-rule/function-rule": "error",
     },
     plugins: {
-      "function-rule": defineRule((context) => {
+      "function-rule": functionRule((context) => {
         return {
           DebuggerStatement(node) {
             context.report({
@@ -63,7 +47,7 @@ export default defineConfig(
               },
             });
           },
-        } satisfies Rule.RuleListener;
+        };
       }),
     },
   },
@@ -76,14 +60,14 @@ export default defineConfig(
 // noDebugger.ts
 
 import type { Rule } from "eslint";
-import { defineRuleListener } from "eslint-plugin-function-rule";
+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) => defineRuleListener({
+    return (context: Rule.RuleContext): Rule.RuleListener => ({
         DebuggerStatement(node) {
             context.report({
                 node,
@@ -101,19 +85,18 @@ export function noDebugger(options?: noDebuggerOptions) {
 ```js
 // eslint.config.ts
 
-// ...
-import { defineRule } from "eslint-plugin-function-rule";
+import { functionRule } from "eslint-plugin-function-rule";
+import { defineConfig } from "eslint/config";
 import { noDebugger } from "./noDebugger.ts";
 
 export default defineConfig(
-  // ...
   {
     files: ["**/*.ts"],
     rules: {
       "function-rule/function-rule": "error",
     },
     plugins: {
-      "function-rule": defineRule(noDebugger({ /* pass rule options */ })),
+      "function-rule": functionRule(noDebugger({/* pass rule options */})),
     },
   },
 );
@@ -124,11 +107,10 @@ export default defineConfig(
 ```js
 // eslint.config.ts
 
-// ...
-import { defineRule } from "eslint-plugin-function-rule";
+import { functionRule } from "eslint-plugin-function-rule";
+import { defineConfig } from "eslint/config";
 
 export default defineConfig(
-  // ...
   {
     files: ["**/*.ts"],
     rules: {
@@ -136,11 +118,11 @@ export default defineConfig(
       "custom-2/function-rule": 2,
     },
     plugins: {
-      "custom-1": defineRule((context) => {
-        return { /* your won rule logic */ }
+      "custom-1": functionRule((context) => {
+        return {/* your won rule logic */};
       }),
-      "custom-2": defineRule((context) => {
-        return { /* your won rule logic */ }
+      "custom-2": functionRule((context) => {
+        return {/* your won rule logic */};
       }),
     },
   },
@@ -150,3 +132,5 @@ export default defineConfig(
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+This project is and will continue to maintain that 90% of the code is written by humans.

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { Rule } from "eslint";
 
 //#region index.d.ts
-declare function defineRule(create: Rule.RuleModule["create"]): {
+declare function functionRule(create: Rule.RuleModule["create"]): {
   readonly rules: {
     readonly "function-rule": {
       readonly meta: {
@@ -14,4 +14,4 @@ declare function defineRule(create: Rule.RuleModule["create"]): {
 };
 declare function defineRuleListener(ruleListener: Rule.RuleListener): Rule.RuleListener;
 //#endregion
-export { defineRule, defineRuleListener };
+export { defineRuleListener, functionRule };

package/dist/index.js

@@ -1,5 +1,5 @@
 //#region index.ts
-function defineRule(create) {
+function functionRule(create) {
 	return { rules: { "function-rule": {
 		meta: {
 			fixable: "code",
@@ -16,4 +16,4 @@ function defineRuleListener(ruleListener) {
 }
 
 //#endregion
-export { defineRule, defineRuleListener };
+export { defineRuleListener, functionRule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-function-rule",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "license": "MIT",
   "sideEffects": false,
   "type": "module",
@@ -18,6 +18,7 @@
     "@eslint/core": "^0.17.0"
   },
   "devDependencies": {
+    "dprint": "^0.50.2",
     "tsdown": "^0.16.1"
   },
   "peerDependencies": {
@@ -25,6 +26,8 @@
     "typescript": "^5"
   },
   "scripts": {
-    "build": "tsdown"
+    "build": "tsdown",
+    "format:check": "dprint check",
+    "format:write": "dprint fmt"
   }
 }