An ESLint plugin for enforcing best practices for Effector.

For comprehensive documentation, including rules and configuration guides, visit official documentation at eslint.effector.dev.

Installation

First, install ESLint and the plugin:

# pnpm
pnpm add --save-dev eslint eslint-plugin-effector

# yarn
yarn add --dev eslint eslint-plugin-effector

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

Usage

This plugin supports the new flat config format for ESLint. Start by adding the recommended preset to your eslint.config.js:

// eslint.config.js
import effector from "eslint-plugin-effector"

export default [
  /* ... */

  // Include the recommended preset:
  effector.flatConfigs.recommended,
]

To explore all available presets, refer to the Rules section of the documentation. For more details or legacy config usage, see the Installation section.

TypeScript Requirement

This plugin leverages TypeScript for accurate linting. You must have TypeScript and type-aware linting configured. For setup instructions, please see the official typescript-eslint documentation.