eslint-plugin-function 0.0.5 → 0.0.7

package/README.md

@@ -0,0 +1,45 @@
+# eslint-plugin-function
+
+The ESLint plugin for function-related rules.
+
+> [!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
+```
+
+## Configure ESLint
+
+```js
+// eslint.config.js
+
+// @ts-check
+import eslintJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+import pluginFunction from "eslint-plugin-function";
+
+export default tseslint.config({
+  files: ["**/*.ts", "**/*.tsx"],
+  extends: [
+    eslintJs.configs.recommended,
+    tseslint.configs.recommended,
+  ],
+  plugins: {
+    function: pluginFunction,
+  },
+  languageOptions: {
+    parser: tseslint.parser,
+    parserOptions: {
+      project: "./tsconfig.json",
+    },
+  },
+  rules: {
+    // Enforce functions matching the given pattern always return a boolean value
+    "function/function-return-boolean": ["error", { pattern: "/^(is|has|should)/" }],
+  },
+});
+```

package/dist/index.d.ts

@@ -6,7 +6,7 @@ declare const _default: {
         readonly version: string;
     };
     readonly rules: {
-        readonly "function-definition": _typescript_eslint_utils_ts_eslint.RuleModule<CamelCase<"function-definition">, [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener>;
+        readonly "function-definition": _typescript_eslint_utils_ts_eslint.RuleModule<"functionDefinition", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener>;
         readonly "function-return-boolean": _typescript_eslint_utils_ts_eslint.RuleModule<"functionReturnBoolean", readonly [{
             readonly pattern?: string;
         } | undefined], unknown, _typescript_eslint_utils_ts_eslint.RuleListener>;

package/dist/index.js

@@ -9,7 +9,7 @@ import { AST_NODE_TYPES } from '@typescript-eslint/types';
 
 // package.json
 var name = "eslint-plugin-function";
-var version = "0.0.5";
+var version = "0.0.7";
 function getDocsUrl() {
   return "TODO: add docs for local ESLint rules";
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-function",
-  "version": "0.0.5",
-  "description": "ESLint plugin for function",
+  "version": "0.0.7",
+  "description": "(WIP) The ESLint plugin for function-related rules.",
   "sideEffects": false,
   "type": "module",
   "exports": {