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

# npm
npm install --save-dev eslint-plugin-function

Configure ESLint

// 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-type-checked"],
  ],
  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)/" }],
  },
});