@wepy/plugin-eslint/README.md

wepy eslint

# wepy eslint 插件

## 安装

```bash
npm install @wepy/plugin-eslint --save-dev
```

## 配置`wepy.config.js`

```javascript
const eslint = require('@wepy/plugin-eslint');

module.exports = {
  plugins: [
    eslint({
      // options
    })
  ]
};
```

## 参数说明

你提供的配置选项 ```options``` 将传递给 ```CLIEngine```处理，有关 ```options``` 的更多详细信息，请参阅[eslint文档](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)。

#### quiet (默认值: ```false```)

如果此选项设置为true，插件将仅处理和报告错误，忽略警告

```javascript
const eslint = require('@wepy/plugin-eslint');

module.exports = {
  plugins: [
    eslint({
      quiet: true
    })
  ]
};
```
#### fix (default: ```false```)

启用 ```ESLint``` 自动修复功能

注意：此选项将更改源文件

#### output (default: ```true```)

启用 ```ESLint```

#### eslintPath (default: ```eslint```)

用于 ```linting``` 的 ```ESLint``` 实例的路径

#### formatter (default: eslint stylish formatter)

用于格式化 ```ESLint``` 输出，选项值接收字符串或者函数

```javascript
const eslint = require('@wepy/plugin-eslint');

module.exports = {
  plugins: [
    eslint({
      // default value
      formatter: require('eslint/lib/formatters/stylish'),

      // community formatter
      formatter: require('eslint-friendly-formatter'),

      // custom formatter
      formatter: function(results) {
        // `results` format is available here
        // http://eslint.org/docs/developer-guide/nodejs-api.html#executeonfiles()

        // you should return a string
        // DO NOT USE console.*() directly !
        return 'OUTPUT'
      }
    })
  ]
};
```