vue開發之代碼規范eslint

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

豌豆資源搜索網站https://55wd.com 廣州vi設計公司http://www.maiqicn.com

取消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