/eslint-plugin

Enforcing best practices for Effector

Primary LanguageJavaScriptMIT LicenseMIT

eslint-plugin-effector

Enforcing best practices for Effector

This plugin uses TypeScript for more precise results, but JavaScript is supported too.

Installation

First, install ESLint:

$ yarn add -D eslint

Next, install eslint-plugin-effector:

$ yarn add -D eslint-plugin-effector

Usage

Add effector to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["effector"],
  "extends": ["plugin:effector/recommended", "plugin:effector/scope"]
}

To configure individual rules:

{
  "rules": {
    "effector/enforce-store-naming-convention": "off"
  }
}

Available rules by preset

plugin:effector/recommended

This preset is recommended for most projects.

plugin:effector/scope

This preset is recommended for projects that use Fork API. You can read more about Fork API in an article.

plugin:effector/react

This preset is recommended for projects that use React with Effector.

plugin:effector/future

This preset contains rules wich enforce future-effector code-style.

Maintenance

Release flow

  1. Bump version in package.json
  2. Fill CHANGELOG.md
  3. Commit changes by git commit -m "Release X.X.X"
  4. Create git tag for release by git tag -a vX.X.X -m "vX.X.X"
  5. Push changes to remote by git push --follow-tags
  6. Release package to registry by yarn clean-publish
  7. Fill release page with changelog on GitHub