关于eslint代码规范检测

最近在项目中需要配置前端的代码规范检测，以下是自己在看一些文档之后，配置的一些检测文件
复制代码

需要的依赖包

npm i babel-eslint
npm i eslint
npm i eslint-loader
npm i eslint-plugin-vue
npm i husky
npm i lint-staged
npm i vue-eslint-parser

1. Eslint配置文件说明

1.1 .eslintrc.js文件配置

/* eslint-disable no-magic-numbers */
module.exports = {
  'root': true, // 此项是用来告诉eslint找当前配置文件不能往父级查找
  'env': {
    'browser': true, // 此项指定环境的全局变量，下面的配置指定为浏览器环境
    'es6': true,
    'node': true
  },
  'extends': ['plugin:vue/recommended', 'eslint:recommended'], // 此项是用来配置检测标准的风格
  'parser': 'vue-eslint-parser',
  'parserOptions': {
    'ecmaVersion': 2020,
    'parser': 'babel-eslint', // 此项是用来指定eslint解析器的，解析器必须符合规则，babel-eslint解析器是对babel解析器的包装使其与ESLint解析
    'sourceType': 'module' // 此项是用来指定javaScript语言类型和风格，sourceType用来指定js导入的方式，默认是script，此处设置为module，指某块导入方式
  },
  // 此项是用来提供插件的，插件名称省略了eslint-plugin-，下面这个配置是用来规范vue的
  'plugins': [
    'vue'
  ],
  // 下面这些rules是用来设置自定义的规范代码的规则
  'rules': {
    'vue/max-attributes-per-line': [2, {
      'singleline': 10,
      'multiline': {
        'max': 1,
        'allowFirstLine': false
      }
    }],
    'vue/singleline-html-element-content-newline': 'off',
    'vue/multiline-html-element-content-newline': 'off',
    'vue/name-property-casing': ['error', 'PascalCase'],
    'vue/no-v-html': 'off',
    'vue/html-self-closing': ['error', {
      'html': {
        'void': 'never',
        'normal': 'always',
        'component': 'always'
      },
      'svg': 'always',
      'math': 'always'
    }],
    'accessor-pairs': 2,
    'arrow-spacing': [2, {
      'before': true,
      'after': true
    }],
    'block-spacing': [2, 'always'],
    'brace-style': [2, '1tbs', {
      'allowSingleLine': true
    }],
    'camelcase': [0, {
      'properties': 'always'
    }],
    'comma-dangle': [2, 'never'],
    'comma-spacing': [2, {
      'before': false,
      'after': true
    }],
    'comma-style': [2, 'last'],
    'constructor-super': 2,
    'curly': [2, 'multi-line'],
    'dot-location': [2, 'property'],
    'eol-last': 2,
    'eqeqeq': ['error', 'always', { 'null': 'ignore' }],
    'generator-star-spacing': [2, {
      'before': true,
      'after': true
    }],
    'handle-callback-err': [2, '^(err|error)$'],
    'indent': [2, 2, {
      'SwitchCase': 1
    }],
    'jsx-quotes': [2, 'prefer-single'],
    'key-spacing': [2, {
      'beforeColon': false,
      'afterColon': true
    }],
    'keyword-spacing': [2, {
      'before': true,
      'after': true
    }],
    'new-cap': [2, {
      'newIsCap': true,
      'capIsNew': false
    }],
    'new-parens': 2,
    'no-array-constructor': 2,
    'no-caller': 2,
    'no-console': 'off',
    'no-class-assign': 2,
    'no-cond-assign': 2,
    'no-const-assign': 2,
    'no-control-regex': 0,
    'no-delete-var': 2,
    'no-dupe-args': 2,
    'no-dupe-class-members': 2,
    'no-dupe-keys': 2,
    'no-duplicate-case': 2,
    'no-empty-character-class': 2,
    'no-empty-pattern': 2,
    'no-eval': 2,
    'no-ex-assign': 2,
    'no-extend-native': 2,
    'no-extra-bind': 2,
    'no-extra-boolean-cast': 2,
    'no-extra-parens': [2, 'functions'],
    'no-fallthrough': 2,
    'no-floating-decimal': 2,
    'no-func-assign': 2,
    'no-implied-eval': 2,
    'no-inner-declarations': [2, 'functions'],
    'no-invalid-regexp': 2,
    'no-irregular-whitespace': 2,
    'no-iterator': 2,
    'no-label-var': 2,
    'no-labels': [2, {
      'allowLoop': false,
      'allowSwitch': false
    }],
    'no-lone-blocks': 2,
    'no-mixed-spaces-and-tabs': 2,
    'no-multi-spaces': 2,
    'no-multi-str': 2,
    'no-multiple-empty-lines': [2, {
      'max': 1
    }],
    'no-native-reassign': 2,
    'no-negated-in-lhs': 2,
    'no-new-object': 2,
    'no-new-require': 2,
    'no-new-symbol': 2,
    'no-new-wrappers': 2,
    'no-obj-calls': 2,
    'no-octal': 2,
    'no-octal-escape': 2,
    'no-path-concat': 2,
    'no-proto': 2,
    'no-redeclare': 2,
    'no-regex-spaces': 2,
    'no-return-assign': [2, 'except-parens'],
    'no-self-assign': 2,
    'no-self-compare': 2,
    'no-sequences': 2,
    'no-shadow-restricted-names': 2,
    'no-spaced-func': 2,
    'no-sparse-arrays': 2,
    'no-this-before-super': 2,
    'no-throw-literal': 2,
    'no-trailing-spaces': 2,
    'no-undef': 2,
    'no-undef-init': 2,
    'no-unexpected-multiline': 2,
    'no-unmodified-loop-condition': 2,
    'no-unneeded-ternary': [2, {
      'defaultAssignment': false
    }],
    'no-unreachable': 2,
    'no-unsafe-finally': 2,
    'no-unused-vars': [2, {
      'vars': 'all',
      'args': 'none'
    }],
    'no-useless-call': 2,
    'no-useless-computed-key': 2,
    'no-useless-constructor': 2,
    'no-useless-escape': 0,
    'no-whitespace-before-property': 2,
    'no-with': 2,
    'one-var': [2, {
      'initialized': 'never'
    }],
    'operator-linebreak': [2, 'after', {
      'overrides': {
        '?': 'before',
        ':': 'before'
      }
    }],
    'padded-blocks': [2, 'never'],
    'quotes': [2, 'single', {
      'avoidEscape': true,
      'allowTemplateLiterals': true
    }],
    'semi': [2, 'never'],
    'semi-spacing': [2, {
      'before': false,
      'after': true
    }],
    'space-before-blocks': [2, 'always'],
    'space-before-function-paren': [2, 'never'],
    'space-in-parens': [2, 'never'],
    'space-infix-ops': 2,
    'space-unary-ops': [2, {
      'words': true,
      'nonwords': false
    }],
    'spaced-comment': [2, 'always', {
      'markers': ['global', 'globals', 'eslint', 'eslint-disable', '*package', '!', ',']
    }],
    'template-curly-spacing': [2, 'never'],
    'use-isnan': 2,
    'valid-typeof': 2,
    'wrap-iife': [2, 'any'],
    'yield-star-spacing': [2, 'both'],
    'yoda': [2, 'never'],
    'prefer-const': 2,
    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
    'object-curly-spacing': [2, 'always', {
      objectsInObjects: false
    }],
    'array-bracket-spacing': [2, 'never']
  }
}
复制代码

1.2 webpack.config.js 文件配置

// webpack.config.js
module.exports = {
  // ... 其它选项
  // 由于我们的项目使用了webpack并且代码都是经过Babel编译的,但是Babel处理过的代码有些语法可能对于eslint支持性不好
  // 配置一下以下模块可以先执行检测再进行代码打包编译
  module: {
    rules: [
      {
        enforce: 'pre', // 强制先执行eslint-loader
        test: /\.(js|vue)$/,
        loader: 'eslint-loader',
        exclude: /node_modules/
      }
    ]
  }
}
复制代码

• 一般不会使用eslint-loader配置在webpack中，会影响打包速度，会在下面说到，在git的时候会进行必要的代码检测，然后直接打包

1.3 两个基本的eslint文件配置好了，现在就是如何启用他去检测我们的代码，接下来就是在package.json文件中配置启动项了

{
  "name": "",
  "version": "",
  "private": true,
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    // *目录下代表所以文件
    "fix": "eslint src/**/**/*.{js,vue} --fix", // npm执行自动修复
    "lint": "eslint src/**/**/*.{js,vue}", // npm执行检测
  },
复制代码

• （1）“lint”：使用npm run lint 就会启动eslint检测了,使用之后，在文件中出现不符合规则的代码就会被检测出来，显示在哪个路径下和具体在哪一行和错误的原因在后面也会有说明。

• （2）“fix”：使用npm run fix 会启用在eslint中可以被默认认为可以自动修复的一些简单的代码

1.4 由于并不是每次都会记得提交代码之前都会去lint一下的，所以在这里又添加了一个代码配置，在每次提交代码commit的时候都会进行一次代码检测

  // husky 插件 
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  // lint-staged配置在commit时执行检测
  "lint-staged": {
    "src/**/**/*.{js,json,css,vue}": [
      "eslint src/**/**/*.{js,vue}",
      "git add"
    ]
  },
复制代码

• 这个时候在回到错误代码文件中整改代码后再次进行add和commit就可以进行commit了，接下来就可以push到远程仓库了，再进行直接打包，不配置webpack文件进行eslint-loader，提示打包速度

2. 关于实时检测代码书写规范的插件

2.1 我们使用的是vscode编译器，它里面包含了一个插件，叫做eslint，可以实时检测代码书写规范，并做出提示，感兴趣的可以去插件库搜索一下

2.2 下载之后如果需要保存的时候自动进行修复，需要在设置中进行配置一下

// 配置eslint
// 保存自动格式化
"editor.formatOnSave": true,
"eslint.autoFixOnSave": true,  // 启用保存时自动修复,默认只支持.js文件
"eslint.validate": [
    "javascript",  // 用eslint的规则检测js文件
    "javascriptreact",
    "vue-html",
    {
    "language": "vue",   // 检测vue文件
    "autoFix": true   // 为vue文件开启保存自动修复的功能
    },
    {
    "language": "html",
    "autoFix": true
    },
],
"eslint.run": "onSave",
"files.autoSave": "afterDelay"
复制代码

3. 最后附上项目基本的目录

  - src	
	  - views
	     - Login.vue
	     - Home.vue
	  - App.vue
	  - main.js
	.eslintrc.js
	package.json
	vue.config.js
	webpack.config.js
复制代码