项目作者: tribou

项目描述 :
Start with JS Standard style but push towards better readability, git-awareness, vim-usability, and React and ES6 best practices
高级语言: JavaScript
项目地址: git://github.com/tribou/eslint-plugin-tribou.git
创建时间: 2017-05-31T02:25:57Z
项目社区:https://github.com/tribou/eslint-plugin-tribou

开源协议:MIT License

下载


eslint-plugin-tribou

npm version
CircleCI
Project Status: Active - The project has reached a stable, usable state and is being actively developed.

Start with JS Standard Style but push towards better readability,
git-awareness, vim-usability, and React and ES6 best practices.

Quick Start

NOTE: If you’re migrating from eslint-config-tribou and want to maintain
compatibility, see the Legacy
Configuration
.

  1. npm install --save-dev \
  2. eslint-plugin-tribou \
  3. babel-eslint \
  4. eslint

Then add the following to your .eslintrc:

  1. {
  2. "extends": [
  3. "plugin:tribou/recommended"
  4. ],
  5. "plugins": [
  6. "tribou"
  7. ]
  8. }

Or add an .eslintrc.yml:

  1. extends:
  2. - plugin:tribou/recommended
  3. plugins:
  4. - tribou
  5. # Wow, that was easier... 😉

Flow

By default, Flow typing is required for an entire project since
eslint-plugin-flowtype will require the \\ @flow annotation to be set at
the top of every file and subsequently check for all other flow annotation
requirements in that file. This allows new projects to enforce Flow typing on
every file from the start.

If you do not wish to use Flow typing on every file (or at all) in a project,
this config can still enforce all of its other standards (including Flow
linting on files that do have the // @flow annotation). To disable this
“universal” Flow typing requirement in your .eslintrc:

  1. {
  2. ...
  3. "settings": {
  4. "flowtype": {
  5. "onlyFilesWithFlowAnnotation": true
  6. }
  7. }
  8. }

Or in your .eslintrc.yml:

  1. ...
  2. settings:
  3. flowtype:
  4. onlyFilesWithFlowAnnotation: true

Prettier Usage

Like using prettier? You can ignore rules that affect
prettier styles with
eslint-config-prettier

Install:

  1. npm install --save-dev eslint-config-prettier

And add the configs to your .eslintrc.yml:

  1. extends:
  2. - plugin:tribou/recommended
  3. - prettier
  4. - prettier/flowtype
  5. - prettier/react
  6. plugins:
  7. - tribou

Legacy Configuration

In order to apply the rules equivalent to eslint-config-tribou@^3.0.0,
install v0.3.0 instead:

  1. npm install --save-dev \
  2. eslint-plugin-tribou@^0.3.0 \
  3. babel-eslint@^8.0.0 \
  4. eslint@^4.0.0