阅读 20

记录2021-08-27

ESLint学习

ESLint 是在 ECMAScript/JavaScript 代码中识别和报告模式匹配的工具,它的目标是保证代码的一致性和避免错误。在许多方面,它和 JSLint、JSHint 相似,除了少数的例外:

  • ESLint 使用 Espree 解析 JavaScript。
  • ESLint 使用 AST 去分析代码中的模式
  • ESLint 是完全插件化的。每一个规则都是一个插件并且你可以在运行时添加更多的规则。

官网地址:eslint.bootcss.com/docs/user-g…

最近在项目中使用 Eslint,这仅仅是个工具,帮助我们可以更好的规范代码

我觉得每个程序员都应该养成良好的代码规范,因为这样才能更好的协同工作,让别人看的赏心悦目,方便管理代码

Eslint 的含义

Lint 是检验代码格式工具的一个统称,具体的工具有 JslintEslint

参考文章:www.jianshu.com/p/ad1e46faa…

这个文章写的很好很全,简单易懂。

Vscode中使用ESLint

首先打开拓展市场搜索eslint,找到如下插件,点击安装即可

image-20210827231410870

然后在设置中,添加如下代码。新版vscode的设置如下,老版本的话部分配置项已经移除,比如新版默认自动fixed(修复)代码

  //autoFixedOnSave 设置已废弃,采用如下新的设置
     "editor.codeActionsOnSave": {
         "source.fixAll.eslint": true
     },
     "eslint.format.enable": true,
     //autoFix默认开启,只需输入字符串数组即可
     "eslint.validate": [
         "javascript",
         "vue",
         "html"
     ]
复制代码

之后我们在项目中根目录创建如下文件,则会被插件默认识别,并采用文件中我们定义的规则,来检查我们项目中的代码,文件保存时候会触发代码检查并且vscode中该插件会根据规则来修复代码

image-20210827231752593

 module.exports = {
   root: true,
   parserOptions: {
     parser: 'babel-eslint',
     sourceType: 'module'
   },
   env: {
     browser: true,
     node: true,
     es6: true,
   },
   extends: ['plugin:vue/recommended', 'eslint:recommended'],
 ​
   // add your custom rules here
   //it is base on https://github.com/vuejs/eslint-config-vue
   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",
     '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']
   }
 }
 ​
复制代码

\

文章分类
前端
文章标签