1. 技术文章
  2. vue开发之代码规范eslint

vue开发之代码规范eslint

由 感情迁移 提交于 2020-05-08 18:49:32

ESLint

 不管是多人合作还是个人项目，代码规范都是很重要的。这样做不仅可以很大程度地避免基本语法错误，也保证了代码的可读性。

准备工作

一、VSCode ESLint插件

ESLint插件用于根据工程目录的.eslintrc.js配置文件在编辑器中显示一些错误提示。

二、基于vue-cli创建项目

具体步骤如下：

  1. 创建项目

     

  2. 创建的时候把Linter/Formatter选上(默认已选上)

     

  3. 下一步选择ESLint with error prevention only

     

  4. 下一步选择Lint on save (在编辑保存之后根据对代码格式进行检测)

     

  5. 下一步选择In dedicated config files(将eslint的配置抽离到独立的文件中)

     

  6. 剩下的步骤默认下一步，即可完成项目的创建

     

配置项

所有的配置文件都在 .eslintrc.js 中，默认情况下使用了plugin:vue/essential来校验代码，当然，你也可以选择最严格的plugin:vue/recommended来校验代码。

module.exports = {
  extends: ['plugin:vue/recommended', 'eslint:recommended']
  //你可以修改为  extends: ['plugin:vue/essential', 'eslint:recommended']
}

eslint规则

默认eslint规则：

  • 代码末尾不能加分号
  • 代码中不能存在多行空行
  • tab键不能使用，必须换成两个空格
  • 代码中不能存在声明了但未使用的变量

自定义规则
如果默认的eslint规则不符合你的习惯，可以自定义规则。找到以.eslintrc.js为名的配置文件，其中的rules就是配置规则的。

rules: {
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
  }

常见的规则如下：

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, //在对象中使用getter/setter
    'arrow-spacing': [
      2,
      {
        before: true,
        after: true
      }
    ], //=>的前/后括号
    'block-spacing': [2, 'always'], //块是否需要空格
    // if while function 后面的{必须与if在同一行，java风格。
    'brace-style': [
      2,
      '1tbs',
      {
        allowSingleLine: true
      }
    ],
    //强制驼峰法命名
    camelcase: [
      0,
      {
        properties: 'always'
      }
    ],
    // 数组和对象键值对最后一个逗号， never参数：不能带末尾的逗号, always参数：必须带末尾的逗号，  
    // always-multiline：多行模式必须带逗号，单行模式不能带逗号 
    'comma-dangle': [2, 'never'],
    // 控制逗号前后的空格
    'comma-spacing': [
      2,
      {
        before: false,
        after: true
      }
    ],
    'comma-style': [2, 'last'], // 控制逗号在行尾出现还是在行首出现
    // 强制在子类构造函数中用super()调用父类构造函数，TypeScrip的编译器也会提示
    'constructor-super': 2,
    curly: [2, 'multi-line'], // 强制所有控制语句使用一致的括号风格
    // 强制object.key 中 . 的位置，参数:  
    // property，'.'号应与属性在同一行  
    // object, '.' 号应与对象名在同一行
    '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)$'], //nodejs 处理错误
    indent: [
      2,
      2,
      {
        SwitchCase: 1
      }
    ],  //缩进风格
    'jsx-quotes': [2, 'prefer-single'], // JSX 属性中一致使用双引号或单引号
    //对象字面量中冒号的前后空格
    'key-spacing': [
      2,
      {
        beforeColon: false,
        afterColon: true
      }
    ], 
    'keyword-spacing': [
      2,
      {
        before: true,
        after: true
      }
    ],
    //函数名首行大写必须使用new方式调用，首行小写必须用不带new方式调用
    'new-cap': [
      2,
      {
        newIsCap: true,
        capIsNew: false
      }
    ],
    'new-parens': 2, //new时必须加小括号
    'no-array-constructor': 2, //禁止使用数组构造器
    'no-caller': 2, //禁止使用arguments.caller或arguments.callee
    'no-console': 'off', //禁止使用console
    'no-class-assign': 2, //禁止给类赋值
    'no-cond-assign': 2, //禁止在条件表达式中使用赋值语句
    'no-const-assign': 2, //禁止修改const声明的变量
    'no-control-regex': 0, //禁止在正则表达式中使用控制字符
    'no-delete-var': 2, //不能对var声明的变量使用delete操作符
    'no-dupe-args': 2, //函数参数不能重复
    'no-dupe-class-members': 2, //不允许类中出现重复的声明
    'no-dupe-keys': 2, //在创建对象字面量时不允许键重复 {a:1,a:1}
    'no-duplicate-case': 2, //switch中的case标签不能重复
    'no-empty-character-class': 2, //正则表达式中的[]内容不能为空
    'no-empty-pattern': 2, // 禁止使用空解构模式
    'no-eval': 2, //禁止使用eval
    'no-ex-assign': 2, //禁止给catch语句中的异常参数赋值
    'no-extend-native': 2, //禁止扩展native对象
    'no-extra-bind': 2, //禁止不必要的函数绑定
    'no-extra-boolean-cast': 2, //禁止不必要的bool转换
    'no-extra-parens': [2, 'functions'], //禁止非必要的括号
    'no-fallthrough': 2, //禁止switch穿透
    'no-floating-decimal': 2, //禁止省略浮点数中的0 .5 3.
    'no-func-assign': 2, //禁止重复的函数声明
    'no-implied-eval': 2, //禁止使用隐式eval
    'no-inner-declarations': [2, 'functions'], //禁止在块语句中使用声明（变量或函数）
    'no-invalid-regexp': 2, //禁止无效的正则表达式
    'no-irregular-whitespace': 2, //不能有不规则的空格
    'no-iterator': 2, //禁止使用__iterator__ 属性
    'no-label-var': 2, //label名不能与var声明的变量名相同
    'no-labels': [  //禁止标签声明
      2,
      {
        allowLoop: false,
        allowSwitch: false
      }
    ],
    'no-lone-blocks': 2, //禁止不必要的嵌套块
    'no-mixed-spaces-and-tabs': 2, //禁止混用tab和空格
    'no-multi-spaces': 2, //不能用多余的空格
    'no-multi-str': 2, //字符串不能用\换行
    'no-multiple-empty-lines': [  //空行最多不能超过1行
      2,
      {
        max: 1
      }
    ],
    'no-native-reassign': 2, //不能重写native对象
    'no-negated-in-lhs': 2, //in 操作符的左边不能有!
    'no-new-object': 2, //禁止使用new Object()
    'no-new-require': 2, //禁止使用new require
    'no-new-symbol': 2, //禁止使用new symbol
    'no-new-wrappers': 2, //禁止使用new创建包装实例，new String new Boolean new Number
    'no-obj-calls': 2, //不能调用内置的全局对象，比如Math() JSON()
    'no-octal': 2, //禁止使用八进制数字
    'no-octal-escape': 2, //禁止使用八进制转义序列
    'no-path-concat': 2, //node中不能使用__dirname或__filename做路径拼接
    'no-proto': 2, //禁止使用__proto__属性
    'no-redeclare': 2, //禁止重复声明变量
    'no-regex-spaces': 2, //禁止在正则表达式字面量中使用多个空格 /foo bar/
    'no-return-assign': [2, 'except-parens'], //return 语句中不能有赋值表达式
    'no-self-assign': 2,  //自我分配
    'no-self-compare': 2, //不能比较自身
    'no-sequences': 2, //禁止使用逗号运算符
    'no-shadow-restricted-names': 2, //严格模式中规定的限制标识符不能作为声明时的变量名使用
    'no-spaced-func': 2,  //函数调用时 函数名与()之间不能有空格
    'no-sparse-arrays': 2,  //禁止稀疏数组， [1,,2]
    'no-this-before-super': 2,  //在调用super()之前不能使用this或super
    'no-throw-literal': 2,  //禁止抛出字面量错误 throw "error";
    'no-trailing-spaces': 2, //一行结束后面不要有空格
    'no-undef': 2, //不能有未定义的变量
    'no-undef-init': 2, //变量初始化时不能直接给它赋值为undefined
    'no-unexpected-multiline': 2, //避免多行表达式
    'no-unmodified-loop-condition': 2, //检查引用是否在循环中被修改
    'no-unneeded-ternary': [  // 禁止可以在有更简单的可替代的表达式时使用三元操作符
      2,
      {
        defaultAssignment: false
      }
    ],
    'no-unreachable': 2, //不能有无法执行的代码
    'no-unsafe-finally': 2, // 禁止对关系运算符的左操作数使用否定操作符，原no-negated-in-lhs已被此替换
    'no-unused-vars': [  //不能有声明后未被使用的变量或参数
      2,
      {
        vars: 'all',
        args: 'none'
      }
    ],
    'no-useless-call': 2, //禁止不必要的call和apply
    'no-useless-computed-key': 2, //没有必要使用带文字的计算属性
    'no-useless-constructor': 2,  //可以在不改变类的工作方式的情况下安全地移除的类构造函数
    'no-useless-escape': 0, // 禁用不必要的转义字符
    'no-whitespace-before-property': 2,  // 禁止属性前有空白
    'no-with': 2, //禁用with
    '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,  //禁止比较时使用NaN，只能用isNaN()
    'valid-typeof': 2,  //必须使用合法的typeof的值
    'wrap-iife': [2, 'any'],  //立即执行函数表达式的小括号风格
    'yield-star-spacing': [2, 'both'], // 强制在 yield* 表达式中 * 周围使用空格
    yoda: [2, 'never'],  //禁止尤达条件
    'prefer-const': 2, //首选const
    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,  //禁止使用debugger
    'object-curly-spacing': [  //大括号内是否允许不必要的空格
      2,
      'always',
      {
        objectsInObjects: false
      }
    ],
    'array-bracket-spacing': [2, 'never'] //是否允许非空数组里面有多余的空格
  }

注意：如果在创建项目的时候没有将eslint配置文件抽离，可以在package.json文件中对eslint进行配置。

"eslintConfig": {
  root: true,
  env: {
    node: true
  },
  'extends': [
    'plugin:vue/essential',
    'eslint:recommended'
  ],
  parserOptions: {
    parser: 'babel-eslint'
  },
  rules: {
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
  }
}

取消ESLint校验

一、 vue-cli2创建的项目

最简单的方法，把 build/webpack.base.conf.js 配置文件中的eslint rules注释掉即可。

二、 vue-cli3创建的项目

  1. 直接注释掉package.json文件中eslint的配置就可以了
  2. vue.config.js中将以下三项设置为false
 devServer: {
        overlay: {
            warnings: false,
            errors: false
        },
      
    }

  lintOnSave: false
标签
strip
webp
javascript
Vue CLI
Curly
eslint
regex
java
bash
Vue.js
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!