最近爲了規範化代碼風格,項目組內啓用了VSCode插件eslint,瞭解eslint的同學都知道,它是在 ECMAScript/JavaScript 代碼中識別和報告模式匹配的工具,給出一些代碼規範建議,其目的是爲了保證代碼的一致性和避免一些可能出現的錯誤。在許多方面,它和 JSLint、JSHint 相似。比如,在書寫下面的代碼時會提示警告(見下圖中波浪線):
其中的錯誤信息是json字符串結構,具體內容如下:
{
"resource": "/g:/project/*/main.js",
"owner": "eslint",
"code": {
"value": "camelcase",
"target": {
"$mid": 1,
"external": "https://eslint.org/docs/rules/camelcase",
"path": "/docs/rules/camelcase",
"scheme": "https",
"authority": "eslint.org"
}
},
"severity": 8,
"message": "Identifier 'indexURL_test' is not in camel case.",
"source": "eslint",
"startLineNumber": 91,
"startColumn": 7,
"endLineNumber": 91,
"endColumn": 20
}
意思就是沒有使用駝峯命名法,根據提示建議,修改如下:
警告⚠️消失了,其實,這並不是說之前的寫法有什麼錯誤。eslint之所以給出相應的提示是爲了在多人維護同一份代碼或工程時,能夠統一命名規範,這樣能夠便於大家互相理解彼此代碼的意思,提升工作效率。當然,這只是一種警告和提示而已,你也可以不理睬,但是這樣的話就失去了你啓用這個插件的意義。
實際項目中,可以做一定的取捨。畢竟不能因爲eslint而影響了擼碼的心情。