https://github.com/effector/eslint-plugin

Enforcing best practices for Effector
https://github.com/effector/eslint-plugin

effector eslint eslint-config eslint-plugin

Last synced: 2 days ago
JSON representation

Enforcing best practices for Effector

• Host: GitHub
• URL: https://github.com/effector/eslint-plugin
• Owner: effector
• License: mit
• Created: 2021-08-28T05:19:03.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-14T13:31:10.000Z (about 2 months ago)
• Last Synced: 2024-12-22T17:07:46.649Z (9 days ago)
• Topics: effector, eslint, eslint-config, eslint-plugin
• Language: JavaScript
• Homepage: https://eslint.effector.dev
• Size: 38.9 MB
• Stars: 92
• Watchers: 12
• Forks: 16
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-effector

Enforcing best practices for [Effector](http://effector.dev/). Documentation available at [eslint.effector.dev](https://eslint.effector.dev/).

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

## Installation

Install [ESLint](http://eslint.org) and `eslint-plugin-effector`:

### pnpm

```

$ pnpm install --dev eslint

$ pnpm install --dev eslint-plugin-effector

```

### yarn

```

$ yarn add --dev eslint

$ yarn add --dev eslint-plugin-effector

```

### npm

```

$ npm install --dev eslint

$ npm install --dev eslint-plugin-effector

```

## Usage

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

```json

{

  "plugins": ["effector"],

  "extends": ["plugin:effector/recommended", "plugin:effector/scope"]

}

```

Read more detailed docs on [eslint.effector.dev](https://eslint.effector.dev/)

## Maintenance

### Release flow

1. Bump `version` in [package.json](package.json)

2. Fill [CHANGELOG.md](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 `pnpm clean-publish`

7. Fill release page with changelog on GitHub