风动之石的博客

ESLint

参考 & 引用文档

规则

规则配置

  • off或0 - 关闭规则
  • warn或1 - 开启规则，使用警告级别的错误：warn(不会导致程序退出)
  • error或2 - 开启规则，使用错误级别的错误：error(当被触发的时候，程序会退出)

Reference: Configuring Rulesopen in new window

行内方式关闭规则

ESlint - Disabling Rules with Inline Commentsopen in new window

ESLint 插件和配置

Vue 相关

  • Babel 相关
  • Vue.js相关
    • eslint-plugin-vue
    • vue-eslint-parser

与 Prettier 的集成

Prettier 与 ESLint 的集成

集成

源码控制

若是想在项目里配置pre-commit钩子来进行提交前的eslint校验，可在项目里添加如下代码.

husky + lint-staged（推荐）

lint-stagedopen in new window，只会让 ESLint 校验暂存区的文件，而不是整个工作目录里的所有文件。

# 快速安装 husky 和 lint-staged
npx mrm lint-staged
1
2

package.json添加如下内容：

{
    // ...
    "husky": {
        "hooks": {
            "pre-commit": "lint-staged",
            "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
        }
    },
    "lint-staged": {
        // 将每一个暂存区的 .js、.vue 文件作为参数，依次传给 eslint --fix 和 git add 执行
        "*.{js,vue}": [
            "eslint --fix",
            "git add"
        ]
    },
    // ...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17