Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 2.26 KB

README.md

File metadata and controls

59 lines (41 loc) · 2.26 KB
Raw

eslint-config-ivweb

npm package NPM downloads

ESLint shareable config for the IVWEB JavaScript style guide.

中文 README

Installation

$ npm install --save-dev eslint eslint-plugin-react eslint-config-ivweb

Documents

Usage

Once the eslint-config-ivweb package is installed, you can use it by specifying ivweb in the extends section of your ESLint configuration.

{
  "extends": "ivweb",
  "rules": {
    // Additional, per-project rules...
  }
}

Using the ivweb config with eslint:recommended

There are several rules in the eslint:recommended ruleset that IVWEB style is not opinionated about that you might want to enforce in your project.

To use IVWEB style in conjunction with ESLint's recommended rule set, extend them both, making sure to list ivweb last:

{
  "extends": ["eslint:recommended", "plugin:react/recommended", "ivweb"],
  "rules": {
    // Additional, per-project rules...
  }
}

To see how the ivweb config compares with eslint:recommended, refer to the source code of index.js, which lists every ESLint rule along with whether (and how) it is enforced by the ivweb config.

Contributing

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository_ on GitHub to start making your changes to the master branch (or branch off of it).
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS_.

License

Apache-2 © IVWEB