eslint-plugin-function-rule 0.0.2 → 0.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,15 +1,121 @@
 # eslint-plugin-function-rule
 
-To install dependencies:
+ESLint plugin to write custom rules with JavaScript functions.
 
-```bash
-bun install
+> [!WARNING]
+> This package is a work in progress and is not yet ready for production use.
+
+## Installation
+
+```sh
+# npm
+npm install --save-dev eslint-plugin-function-rule
+```
+
+## Configure ESLint
+
+### Write function rules inline
+
+```js
+// eslint.config.js
+
+// @ts-check
+import eslintJs from "@eslint/js";
+import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
+import functionRule from "eslint-plugin-function-rule";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+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": functionRule((context) => {
+        return {
+          DebuggerStatement(node) {
+            context.report({
+              node,
+              message: "Remove 'debugger' from code.",
+
+              fix(fixer) {
+                return fixer.remove(node);
+              },
+            });
+          },
+        } satisfies RuleListener;
+      }),
+    },
+  },
+);
 ```
 
-To run:
+### Import function rules from packages
+
+```js
+// noDebugger.ts
+
+/**
+ * Remove console methods from code
+ * @param options The rule options
+ * @returns RuleFunction
+ */
+export function noDebugger(options?: unknown): RuleDefinition["create"] {
+  return (context) => {
+    return {
+      DebuggerStatement(node) {
+        context.report({
+          node,
+          message: "Remove 'debugger' from code.",
+
+          fix(fixer) {
+            return fixer.remove(node);
+          },
+        });
+      },
+    } satisfies RuleListener;
+  };
+}
 
-```bash
-bun run index.ts
 ```
 
-This project was created using `bun init` in bun v1.3.2. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+```js
+// eslint.config.js
+
+// @ts-check
+// ...
+import { noDebugger } from "./noDebugger.ts";
+
+const noDebuggerRule = noDebugger({/* rule options */});
+
+export default defineConfig(
+  // ...
+  {
+    files: ["**/*.ts"],
+    rules: {
+      "function-rule/function-rule": "error",
+    },
+    plugins: {
+      "function-rule": functionRule((context) => {
+        noDebuggerRule(context);
+      }),
+    },
+  },
+);
+```

package/dist/index.d.ts

@@ -3,13 +3,13 @@ import { RuleDefinition } from "@eslint/core";
 
 //#region index.d.ts
 declare function functionRule(create: RuleDefinition["create"]): {
-  rules: {
-    "function-rule": {
-      meta: {
-        fixable: string;
-        hasSuggestions: boolean;
+  readonly rules: {
+    readonly "function-rule": {
+      readonly meta: {
+        readonly fixable: "code";
+        readonly hasSuggestions: true;
       };
-      create: (context: _eslint_core0.RuleContext<{
+      readonly create: (context: _eslint_core0.RuleContext<{
         LangOptions: _eslint_core0.LanguageOptions;
         Code: _eslint_core0.SourceCode<{
           LangOptions: _eslint_core0.LanguageOptions;

package/package.json

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