ESLint中文:
检测并修复 JavaScript 代码中的问题。 - ESLint - 插件化的 JavaScript 代码检查工具

我们在公司进行团队开发项目的时候,每个人的代码风格是不一样这样很容易导致了规范不统一,这个时候就需要使用一种规范来约束我们的代码,ESLint就是用来帮我约束团队代码规范的工具。

配置 eslint 配置文件

安装:

  1. $ npm install eslint --save

初始化ESLint配置文件:

  1. $ npx eslint --init

image.png

这样就初始化了一个ESLint的配置文件。

  1. module.exports = {
  2. "env": {
  3. "browser": true,
  4. "es2021": true
  5. },
  6. "extends": [
  7. "eslint:recommended",
  8. "plugin:react/recommended"
  9. ],
  10. "parserOptions": {
  11. "ecmaFeatures": {
  12. "jsx": true
  13. },
  14. "ecmaVersion": 12,
  15. "sourceType": "module"
  16. },
  17. "plugins": [
  18. "react"
  19. ],
  20. "rules": {
  21. }
  22. };

使用ESLint检查src文件夹下文件代码的是否符合配置的规范:

  1. $ npx eslint src

我们还可以使用VSCode代码编辑器的插件来帮助我们约束代码规范。

eslint-loader

通过使用Webpack + eslint-loader 来帮我们约束代码。
安装:

  1. npm install eslint-loader -D

进行配置:

  1. module.exports = {
  2. // ...
  3. devServer: {
  4. // eslint 出现问题会在页面提示错误
  5. overlay: true,
  6. },
  7. module: {
  8. rules: [
  9. {
  10. test: /\.m?js$/,
  11. // 排除node_modules下的代码
  12. exclude: /node_modules/,
  13. use: ["babel-loader", "eslint-loader"]
  14. }]
  15. },
  16. // ...
  17. }

接着我们运行项目就能看到浏览器中的提示错误。
WX20210325-203346@2x.png

eslint-loader更多配置项:
https://github.com/yannickcr/eslint-plugin-react#configuration

Git 提交检测 ESLint

当我们在Webpack的配置文件配置了ESLint是会影响我们打包速度的。还有一种方式就是Git提交的时候自动检测eslint代码规范,不符合就无法提交,这里就不再进行叙述了。