用 ESLint 和 Prettier 写出高质量代码

用 ESLint 和 Prettier 写出高质量代码

ESLint 可以检测出你代码中潜在的问题，比如使用了某个变量却忘记了定义，而 Prettier 作为代码格式化工具，能够统一你或者你的团队的代码风格。

本文不会介绍这两种工具单独的使用方法，因为相关网络资料已经足够多了。这里我介绍一下怎么同时使用它们。

在 ESLint 中使用 eslint-plugin-prettier

为什么使用这种方法: 希望格式化结果完全符合 Prettier 的要求。

相关依赖:

yarn add prettier eslint-config-prettier eslint-plugin-prettier --dev

eslint-plugin-prettier 的工作原理是，对比格式化前和用 Prettier 格式化后的代码，有不一致的地方就会报错，然后你可以手动运行 eslint --fix 来修复。

不过 Prettier 的格式化很可能和你使用的 ESLint 配置冲突，比如你的 ESLint 设定的不使用分号，而 Prettier 默认使用分号，这时候你需要配置 Prettier 让它不使用分号。反之如果你想使用 Prettier 的规则而不是 ESLint 的，为防止 ESLint 报错，你需要使用 eslint-config-prettier 来关闭所有可能引起冲突的规则。

总结一下我的配置如下 package.json (为了方便展示省略了不必要的部分):

{
  "scripts": {
    "lint": "eslint *.js"
  },
  "eslintConfig": {
    "extends": ["prettier"],
    "plugins": ["prettier"],
    "rules": {
      "prettier/prettier": "error"
    }
  },
  "prettier": {
    "singleQuote": true,
    "semi": false
  }
}

上面高亮的 eslintConfig 可以简化为:

{
  "extends": ["plugin:prettier/recommended"]
}

eslint-plugin-prettier 提供的 recommended 配置会自动添加 eslint-config-prettier 和 eslint-plugin-prettier，为你省去一些手动的配置。

你可以使用大多数编辑器里 ESLint 插件提供的 autoFixOnSave 选项来在保存时自动格式化。

使用 prettier-eslint-cli

为什么使用它: 希望格式化结果完全符合 ESLint 的要求。

相关依赖:

yarn add prettier-eslint-cli --dev

使用 ESLint 与 eslint-plugin-prettier 的结果是最终得到的代码是充分尊重 Prettier 的结果，而 prettier-eslint-cli 则是先执行 Prettier 然后再自动使用 eslint --fix 将与 ESLint 规则冲突的代码修正成 ESLint 想要的结果。这样其实引入 Prettier 不会影响你原有的设置。

总结一下我的配置如下 package.json (为了方便展示省略了不必要的部分):

{
  "scripts": {
    // ESLint 只负责检查代码质量
    "lint": "eslint *.js",
    // 用 Prettier 格式化代码并自动 `eslint --fix `以便下次执行 `npm run lint` 时不会报错
    "format": "prettier-eslint --write *.js"
  },
  "eslintConfig": {
    "extends": "some-config"
  },
  "prettier": {
    "singleQuote": true,
    "semi": false
  }
}

除了命令行的 npm run format，同时你也可以使用编辑器里的 Prettier 插件，并启用 eslintIntegration 来在编辑器里自动格式化代码。

在提交代码时格式化

安装需要的依赖:

yarn add lint-staged husky@next --dev

husky 被用来添加一些 git 钩子，这里我们需要一个用 pre-commit 在每次 git commit 操作时执行 lint-staged 命令。

而 lint-staged 可以对 git 暂存区文件(也就是你想要 commit 的文件)执行一些操作，比如这里我们想在代码被修改后将其格式化:

{
  "lint-staged": {
    "*.js": ["eslint --fix", "git add"]
  },
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  }
}

我个人倾向使用 eslint-plugin-prettier，因为 ESLint 一般是必需的，而使用 ESLint 插件的成本明显比使用一个新的命令行工具(即 prettier-eslint-cli)的成本低多了。