月丶
vscode使用eslintrc及stylelintrc格式化代码
2022-8-4 月丶


1、安装eslit及stylelint插件







2、settings.json 添加配置








"editor.codeActionsOnSave": {


    "source.fixAll": true


  },


  "eslint.validate": [


    "javascript",


    "javascriptreact",


    "typescript",


    "typescriptreact",


  ],


  "eslint.alwaysShowStatus": true,


  "stylelint.validate": [


    "css",


    "less",


    "postcss",


    "scss",


    "vue",


    "sass"


  ],







3、添加.eslintrc.js配置文件



vue2:








// https://cn.eslint.org/docs/rules/


module.exports = {


  'root': true,


  'parserOptions': {


    // 'parser': 'babel-eslint'


    'parser': '@babel/eslint-parser'


  },


  'env': {


    'node': true


  },


  'extends': ['eslint:recommended', 'plugin:vue/recommended'],




  // add your custom rules here


  // 首个参数 0 = off, 1 = warn, 2 = error


  'rules': {


    // 数组内间距


    'array-bracket-spacing': [2, 'never'],


    // 禁止使用拖尾逗号


    'comma-dangle': [2, 'never'],


    // 强制在逗号周围使用空格


    'comma-spacing': [2, { 'before': false, 'after': true }],


    // 禁止逗号前后有换行符


    'comma-style': [2, 'last'],


    // 使用类型安全的 === 和 !== 操作符代替 == 和 != 操作符


    'eqeqeq': [2, 'always'],


    // 缩进


    'indent': [2, 2, { 'SwitchCase': 1 }],


    // 对象 key/value 间 空格


    'key-spacing': [2, { 'afterColon': true }],


    // 关键字周围空格


    'keyword-spacing': [2, { 'after': true }],


    // 禁止直接使用 Object.prototypes 的内置属性


    'no-prototype-builtins': [0],


    // 使用单引号


    'quotes': [2, 'single'],


    // 禁止使用分号


    'semi': [2, 'never'],


    // 函数圆括号之前有一个空格


    'space-before-function-paren': [2, 'always'],


    // 操作符周围空格


    'space-infix-ops': [2],


    // 注释空格


    'spaced-comment': [2, 'always'],


    // 文件末尾保留一行空行


    'eol-last': [2, 'always'],


    // 禁用行尾空白


    'no-trailing-spaces': [2],




    // vue eslint


    // html 缩进


    'vue/html-indent': [2, 2],


    // script 缩进


    'vue/script-indent': [2, 2, { 'baseIndent': 1, 'switchCase': 1 }],


    // 单行元素的内容前后需要换行符


    'vue/singleline-html-element-content-newline': [0],


    // 禁用 v-html 指令


    'vue/no-v-html': [0],


    // 解析错误


    'vue/no-parsing-error': [2, {


      // 标签解析关闭 - 模板中使用“<”会报错


      'invalid-first-character-of-tag-name': false


    }]


  },


  'overrides': [


    {


      // 关闭 vue 文件中的 indent 的默认检查


      // 使用 vue/script-indent 缩进规则


      'files': ['*.vue'],


      'rules': {


        'indent': 'off'


      }


    }


  ]


}









vue3:





// vue3 ts 配置eslint格式化代码


module.exports = {


  'env': {


    'browser': true,


    'es2021': true,


    'node': true


  },


  'extends': 'plugin:vue/vue3-essential',


  'overrides': [


  ],


  'parser': 'vue-eslint-parser',


  'parserOptions': {


    'parser': '@typescript-eslint/parser'


  },


  'plugins': [


    'vue',


    '@typescript-eslint'


  ],


  'rules': {


    'accessor-pairs': 2, // getter/setter 一起使用


    // => 前后有空格


    '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'],


    // 非派生类不能调用super,派生类必须调用super


    'constructor-super': 2,


    'curly': [2, 'multi-line'],


    // 对象访问符的位置,换行的时候在行首还是行尾


    'dot-location': [2, 'property'],


    // 文件以换行符结束


    'eol-last': 2,


    // 必须使用全等,除非与 null 进行比较


    '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 属性中一致使用双引号或单引号


    'jsx-quotes': [2, 'prefer-single'],


    // 对象字面量中冒号的前后空格


    'key-spacing': [2, {


      'beforeColon': false,


      'afterColon': true


    }],


    'keyword-spacing': [2, {


      'before': true,


      'after': true


    }],


    // 函数名首行大写必须使用new方式调用


    'new-cap': [2, {


      'newIsCap': true,


      'capIsNew': false


    }],


    // new时必须加小括号


    'new-parens': 2,


    // 不允许使用构造函数来构造新Array数组,而是倾向于使用数组文字符号


    'no-array-constructor': 2,


    // 不允许使用arguments.caller和arguments.callee


    'no-caller': 2,


    // 是否禁止使用console


    'no-console': 'off',


    // 禁止给类赋值


    'no-class-assign': 2,


    // 禁止在条件表达式中使用赋值语句


    'no-cond-assign': 2,


    // 禁止修改const声明的变量


    'no-const-assign': 2,


    // 禁止在正则表达式中使用 ASCII 控制字符


    'no-control-regex': 0,


    // 不能对var声明的变量使用delete操作符


    'no-delete-var': 2,


    // 函数参数不能重复


    'no-dupe-args': 2,


    // 类成员名不能重复


    'no-dupe-class-members': 2,


    // 在创建对象字面量时不允许键重复


    'no-dupe-keys': 2,


    // switch中的case标签不能重复


    'no-duplicate-case': 2,


    // 不允许在正则表达式中使用空字符类


    'no-empty-character-class': 2,


    // 禁止使用空解构模式


    'no-empty-pattern': 2,


    // 禁止使用eval


    'no-eval': 2,


    // 禁止给catch语句中的异常参数赋值


    'no-ex-assign': 2,


    // 禁止扩展native对象


    'no-extend-native': 2,


    // 禁止不必要的函数绑定


    'no-extra-bind': 2,


    // 禁止不必要的bool转换


    'no-extra-boolean-cast': 2,


    // 禁止非必要的括号


    'no-extra-parens': [2, 'functions'],


    // 禁止switch穿透


    'no-fallthrough': 2,


    // 禁止省略浮点数中的0 如:.5 3.


    'no-floating-decimal': 2,


    // 禁止重复的函数声明


    'no-func-assign': 2,


    // 禁止使用隐式eval


    'no-implied-eval': 2,


    // 禁止在块语句中使用声明(变量或函数)


    'no-inner-declarations': [2, 'functions'],


    // 禁止无效的正则表达式


    'no-invalid-regexp': 2,


    // 不能有不规则的空格


    'no-irregular-whitespace': 2,


    // 禁止使用__iterator__ 属性


    'no-iterator': 2,


    // label名不能与var声明的变量名相同


    'no-label-var': 2,


    // 禁止标签声明


    'no-labels': [2, {


      'allowLoop': false,


      'allowSwitch': false


    }],


    // 禁止不必要的嵌套块


    'no-lone-blocks': 2,


    // 禁止混用tab和空格


    'no-mixed-spaces-and-tabs': 2,


    // 不能用多余的空格


    'no-multi-spaces': 2,


    // 字符串不能用 \ 换行


    'no-multi-str': 2,


    // 空行最多不能超过 1 行


    'no-multiple-empty-lines': [2, {


      'max': 1


    }],


    // 不能重写 native 对象


    'no-native-reassign': 2,


    // in 操作符的左边不能有 !


    'no-negated-in-lhs': 2,


    // 禁止使用new Object()


    'no-new-object': 2,


    // 禁止使用new require


    'no-new-require': 2,


    // 禁止使用new symbol


    'no-new-symbol': 2,


    // 禁止使用new创建包装实例,new String new Boolean new Number


    'no-new-wrappers': 2,


    // 不能调用内置的全局对象,比如 Math() JSON()


    'no-obj-calls': 2,


    // 禁止使用八进制数字


    'no-octal': 2,


    // 禁止使用八进制转义序列


    'no-octal-escape': 2,


    // node中不能使用__dirname或__filename做路径拼接


    'no-path-concat': 2,


    // 禁止使用__proto__属性


    'no-proto': 2,


    // 禁止重复声明变量


    'no-redeclare': 2,


    // 禁止在正则表达式字面量中使用多个空格


    'no-regex-spaces': 2,


    // return 语句中不能有赋值表达式


    '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,


    // 禁止稀疏数组 如:[1,,2]


    'no-sparse-arrays': 2,


    // 在调用super()之前不能使用this或super


    'no-this-before-super': 2,


    // 禁止抛出字面量错误 throw "error";


    'no-throw-literal': 2,


    // 一行结束后面不要有空格


    'no-trailing-spaces': 2,


    // 不能有未定义的变量


    'no-undef': 2,


    // 变量初始化时不能直接给它赋值为undefined


    'no-undef-init': 2,


    // 避免多行表达式


    'no-unexpected-multiline': 2,


    // 禁用一成不变的循环条件


    'no-unmodified-loop-condition': 2,


    // 禁止可以在有更简单的可替代的表达式时使用三元操作符


    'no-unneeded-ternary': [2, {


      'defaultAssignment': false


    }],


    // 不能有无法执行的代码


    'no-unreachable': 2,


    // 禁止在 finally 语句块中出现控制流语句


    'no-unsafe-finally': 2,


    // 不能有声明后未被使用的变量或参数


    'no-unused-vars': [2, {


      'vars': 'all',


      'args': 'none'


    }],


    // 禁止不必要的call和apply


    'no-useless-call': 2,


    // 禁止对象和类中不必要的计算属性键


    'no-useless-computed-key': 2,


    // 不允许不必要的构造函数


    'no-useless-constructor': 2,


    // 不允许不必要的转义字符


    'no-useless-escape': 0,


    // 不允许属性前有空格


    'no-whitespace-before-property': 2,


    // 禁用with


    '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'],


    // 禁止比较时使用NaN,只能用isNaN()


    'use-isnan': 2,


    // 必须使用合法的typeof的值


    'valid-typeof': 2,


    // 立即执行函数表达式的小括号风格


    'wrap-iife': [2, 'any'],


    // yield*表达式间是否使用空格


    'yield-star-spacing': [2, 'both'],


    // 禁止尤达条件


    'yoda': [2, 'never'],


    // 首选const


    'prefer-const': 2,


    // 生产环境禁用 debugger


    // 'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,


    // 大括号内是否允许不必要的空格


    'object-curly-spacing': [2, 'always', {


      objectsInObjects: false


    }],


    // []内是否允许不必要的空格


    'array-bracket-spacing': [2, 'never'],




    /** **** VUE规则 *****/


    // 每行的最大属性数


    'vue/max-attributes-per-line': [2, {


      'singleline': 10, // 处于单行时


      'multiline': 1 // 处于多行时


    }],


    // name 属性强制使用特定大小写


    'vue/component-definition-name-casing': ['error', 'PascalCase'],


    'vue/no-v-html': 'off'


  }


}





4、添加.stylelintrc.js配置文件











module.exports = {


  'extends': ['stylelint-config-standard'],


  'plugins': ['stylelint-order'],


  'rules': {


    // 缩进


    'indentation': [2, { baseIndentLevel: 1 }],


    // 属性 前缀处理


    'property-no-vendor-prefix': null,


    // 属性值 前缀处理


    'value-no-vendor-prefix': null,


    // 选择器不限定类型


    'selector-no-qualifying-type': null,


    // 限制选择器中ID选择器的数量


    'selector-max-id': null,


    'selector-pseudo-element-no-unknown': [


      true,


      {


        'ignorePseudoElements': [


          'v-deep'


        ]


      }


    ],


    'font-family-no-missing-generic-family-keyword': null


  }


}









配合husky保证代码及提交风格一直








"husky": {


    "hooks": {


      "pre-commit": "lint-staged",


      "commit-msg": "validate-commit-msg"


    }


  },


  "lint-staged": {


    "src/**/*.{js,vue}": [


      "eslint --ext"


    ],


    "src/**/*.{css,less,vue}": [


      "stylelint"


    ]


  },





发表评论:
昵称

邮件地址 (选填)

个人主页 (选填)

内容