一個團隊最好要有統一的代碼格式,這裏簡單整理一下,僅供參考
首先,在搭建腳手架的時候的選擇,推薦編輯器vscode:
配合vscode編輯器的 Prettier - Code formatter插件:
注意點:
set.json文件(vscode)
2020更新
由於 vscode 版本更新,以上配置已經失效,需要改爲
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
},
配置完之後,VSCode 會根據你當前 Vue 項目下的 .eslintrc.js
文件的規則來驗證和格式化代碼。
PS:自動格式化代碼在保存時自動觸發,目前試了 TS 和 JS 以及 vue 文件中的 JS 代碼都沒問題,html 和 vue 中的 html 和 css 無效。
擴展
其實還是有辦法格式化 vue 文件中的 html 和 css 代碼的,利用 vscode 自帶的格式化,快捷鍵是 shift + alt + f
,假設你當前 vscode 打開的是一個 vue 文件,按下 shift + alt + f
會提示你選擇一種格式化規範,如果沒提示,那就是已經有默認的格式化規範了(一般是 vetur 插件),然後 vue 文件的所有代碼都會格式化,並且格式化規則還可以自己配置,如下圖所示,可以根據自己的喜好來選擇格式化規則。
setting.json配置:
{
"window.zoomLevel": 0,
"editor.minimap.enabled": false,
"search.followSymlinks": false,
"explorer.confirmDelete": false,
"workbench.colorTheme": "Vue Theme",
"editor.fontSize": 16,
"editor.formatOnSave": true, // 保存自動格式化
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}
這時需要特殊配置檢查代碼格式的話只需要對你當前 Vue 項目下的 .eslintrc.js
文件進行配置即可(配置此文件後,需重啓項目)。
關於.eslintrc.js的配置:
'rules': {
"comma-dangle": ["error", "never"], //是否允許對象中出現結尾逗號
"no-cond-assign": 2, //條件語句的條件中不允許出現賦值運算符
"no-console": 2, //不允許出現console語句
"no-constant-condition": 2, //條件語句的條件中不允許出現恆定不變的量
"no-control-regex": 2, //正則表達式中不允許出現控制字符
"no-debugger": 2, //不允許出現debugger語句
"no-dupe-args": 2, //函數定義的時候不允許出現重複的參數
"no-dupe-keys": 2, //對象中不允許出現重複的鍵
"no-duplicate-case": 2, //switch語句中不允許出現重複的case標籤
"no-empty": 2, //不允許出現空的代碼塊
"no-empty-character-class": 2, //正則表達式中不允許出現空的字符組
"no-ex-assign": 2, //在try catch語句中不允許重新分配異常變量
"no-extra-boolean-cast": 2, //不允許出現不必要的布爾值轉換
"no-extra-parens": 0, //不允許出現不必要的圓括號
"no-extra-semi": 2, //不允許出現不必要的分號
"no-func-assign": 2, //不允許重新分配函數聲明
"no-inner-declarations": ["error", "functions"], //不允許在嵌套代碼塊裏聲明函數
"no-invalid-regexp": 2, //不允許在RegExp構造函數裏出現無效的正則表達式
"no-irregular-whitespace": 2, //不允許出現不規則的空格
"no-negated-in-lhs": 2, //不允許在in表達式語句中對最左邊的運算數使用取反操作
"no-obj-calls": 2, //不允許把全局對象屬性當做函數來調用
"no-regex-spaces": 2, //正則表達式中不允許出現多個連續空格
"quote-props": 2, //對象中的屬性名是否需要用引號引起來
"no-sparse-arrays": 2, //數組中不允許出現空位置
"no-unreachable": 2, //在return,throw,continue,break語句後不允許出現不可能到達的語句
"use-isnan": 2, //要求檢查NaN的時候使用isNaN()
"valid-jsdoc": ["error", {
"requireReturn": false,
"requireParamDescription": false,
"requireReturnDescription": true
}], //強制JSDoc註釋
"valid-typeof": ["error", {
"requireStringLiterals": true
}], //在使用typeof表達式比較的時候強制使用有效的字符串
"block-scoped-var": 2, //將變量聲明放在合適的代碼塊裏
"complexity": 0, //限制條件語句的複雜度
"consistent-return": 2, //無論有沒有返回值都強制要求return語句返回一個值
"curly": ["error", "all"], //強制使用花括號的風格
"default-case": 0, //在switch語句中需要有default語句
"dot-notation": ["error", {"allowKeywords": false, "allowPattern": ""}], //獲取對象屬性的時候使用點號
"eqeqeq": ["error", "smart"], //比較的時候使用嚴格等於
"no-alert": 1, //不允許使用alert,confirm,prompt語句
"no-caller": 2, //不允許使用arguments.callee和arguments.caller屬性
"guard-for-in": 0, //監視for in循環,防止出現不可預料的情況
"no-div-regex": 2, //不能使用看起來像除法的正則表達式
"no-else-return": 0, //如果if語句有return,else裏的return不用放在else裏
"no-labels": ["error", {
"allowLoop": false,
"allowSwitch": false
}], //不允許標籤語句
"no-eq-null": 2, //不允許對null用==或者!=
"no-eval": 2, //不允許使用eval()
"no-extend-native": 2, //不允許擴展原生對象
"no-extra-bind": 2, //不允許不必要的函數綁定
"no-fallthrough": 2, //不允許switch按順序全部執行所有case
"no-floating-decimal": 2, //不允許浮點數缺失數字
"no-implied-eval": 2, //不允許使用隱式eval()
"no-iterator": 2, //不允許使用__iterator__屬性
"no-lone-blocks": 2, //不允許不必要的嵌套代碼塊
"no-loop-func": 2, //不允許在循環語句中進行函數聲明
"no-multi-spaces": 2, //不允許出現多餘的空格
"no-multi-str": 2, //不允許用\來讓字符串換行
"no-global-assign": 2, //不允許重新分配原生對象
"no-new": 2, //不允許new一個實例後不賦值或者不比較
"no-new-func": 2, //不允許使用new Function
"no-new-wrappers": 2, //不允許使用new String,Number和Boolean對象
"no-octal": 2, //不允許使用八進制字面值
"no-octal-escape": 2, //不允許使用八進制轉義序列
"no-param-reassign": 0, //不允許重新分配函數參數"no-proto": 2, //不允許使用__proto__屬性
"no-redeclare": 2, //不允許變量重複聲明
"no-return-assign": 2, //不允許在return語句中使用分配語句
"no-script-url": 2, //不允許使用javascript:void(0)
"no-self-compare": 2, //不允許自己和自己比較
"no-sequences": 2, //不允許使用逗號表達式
"no-throw-literal": 2, //不允許拋出字面量錯誤 throw "error"
"no-unused-expressions": 2, //不允許無用的表達式
"no-void": 2, //不允許void操作符
"no-warning-comments": [1, {"terms": ["todo", "fixme", "any other term"]}], //不允許警告備註
"no-with": 2, //不允許使用with語句
"radix": 1, //使用parseInt時強制使用基數來指定是十進制還是其他進制
"vars-on-top": 0, //var必須放在作用域頂部
"wrap-iife": [2, "any"], //立即執行表達式的括號風格
"yoda": [2, "never", {"exceptRange": true}], //不允許在if條件中使用yoda條件
"strict": [2, "function"], //使用嚴格模式
"no-catch-shadow": 2, //不允許try catch語句接受的err變量與外部變量重名"no-delete-var": 2, //不允許使用delete操作符
"no-label-var": 2, //不允許標籤和變量同名
"no-shadow": 2, //外部作用域中的變量不能與它所包含的作用域中的變量或參數同名
"no-shadow-restricted-names": 2, //js關鍵字和保留字不能作爲函數名或者變量名
"no-undef": 2, //不允許未聲明的變量
"no-undef-init": 2, //不允許初始化變量時給變量賦值undefined
"no-undefined": 2, //不允許把undefined當做標識符使用
"no-unused-vars": [2, {"vars": "all", "args": "after-used"}], //不允許有聲明後未使用的變量或者參數
"no-use-before-define": [2, "nofunc"], //不允許在未定義之前就使用變量"indent": 2, //強制一致的縮進風格
"brace-style": [2, "1tbs", { "allowSingleLine": false}], //大括號風格
"camelcase": [2, {"properties": "never"}], //強制駝峯命名規則
"comma-style": [2, "last"], //逗號風格
"consistent-this": [0, "self"], //當獲取當前環境的this是用一樣的風格
"eol-last": 2, //文件以換行符結束
"func-names": 0, //函數表達式必須有名字
"func-style": 0, //函數風格,規定只能使用函數聲明或者函數表達式
"key-spacing": [2, {"beforeColon": false, "afterColon": true}], //對象字面量中冒號的前後空格
"max-nested-callbacks": 0, //回調嵌套深度
"new-cap": [2, {"newIsCap": true, "capIsNew": false}], //構造函數名字首字母要大寫
"new-parens": 2, //new時構造函數必須有小括號
"newline-after-var": 0, //變量聲明後必須空一行
"no-array-constructor": 2, //不允許使用數組構造器
"no-inline-comments": 0, //不允許行內註釋
"no-lonely-if": 0, //不允許else語句內只有if語句
"no-mixed-spaces-and-tabs": [2, "smart-tabs"], //不允許混用tab和空格
"no-multiple-empty-lines": [2, {"max": 2}], //空行最多不能超過兩行
"no-nested-ternary": 2, //不允許使用嵌套的三目運算符
"no-new-object": 2, //禁止使用new Object()
"fun-call-spacing": 2, //函數調用時,函數名與()之間不能有空格
"no-ternary": 0, //不允許使用三目運算符
"no-trailing-spaces": 2, //一行最後不允許有空格
"no-underscore-dangle": 2, //不允許標識符以下劃線開頭
"no-extra-parens": 0, //不允許出現多餘的括號
"one-var": 0, //強制變量聲明放在一起
"operator-assignment": 0, //賦值運算符的風格
"padded-blocks": [2, "never"], //塊內行首行尾是否空行
"quote-props": 0, //對象字面量中屬性名加引號
"quotes": [1, "single", "avoid-escape"], //引號風格
"semi": [2, "always"], //強制語句分號結尾
"semi-spacing": [2, {"before": false, "after": true}], //分後前後空格
"sort-vars": 0, //變量聲明時排序
"space-before-blocks": [2, "always"], //塊前的空格
"space-before-function-paren": [2, {"anonymous": "always", "named": "never"}], //函數定義時括號前的空格
"space-infix-ops": [2, {"int32Hint": true}], //操作符周圍的空格
"keyword-spacing": 2, //關鍵字前後的空格
"space-unary-ops": [2, { "words": true, "nonwords": false}], //一元運算符前後不要加空格
"wrap-regex": 2, //正則表達式字面量用括號括起來
"no-var": 0, //使用let和const代替var
"generator-star-spacing": [2, "both"], //生成器函數前後空格
"max-depth": 0, //嵌套塊深度
"max-len": 0, //一行最大長度,單位爲字符
"max-params": 0, //函數最多能有多少個參數
"max-statements": 0, //函數內最多有幾個聲明
"no-bitwise": 0, //不允許使用位運算符
"no-plusplus": 0 //不允許使用++ --運算符
}