Saber前端框架用ESlint規范統一項目代碼風格

一、前言


??由于公司Saber前端框架沒有進行ESlint代碼規范的約束,導致在開發過程中,各種代碼風格迥異,無法形成規范,造成以后維護的困難。為此,我司決定用ESlint規范統一項目風格。

二、代碼風格


  • 整體風格
    • javascript大體上遵循ESlint規范
    • htmlwxml大體上遵循prettyhtml規范
  • javascript細節調整
    • 結尾無分號
    • 超過140個字符換行
    • 使用單引號
    • 無尾隨逗號
    • 箭頭函數單個參數不加分號
    • 函數聲明時禁止圓括號前有空格

三、前期準備


四、項目添加ESlint


1、在項目.eslintrc.js中添加 函數聲明時禁止圓括號前有空格 規則

??解決Prettier格式化時與ESlint規范沖突報錯。沖突原因可參考prettier 不支持函數后空格? 看社區怎么說

// 函數聲明時禁止圓括號前有空格
'space-before-function-paren': 'off'
函數聲明時禁止圓括號前有空格
2、項目根目錄添加.prettierrc,規定Prettier格式化規則

??解決格式化js文件時,定義的規則沒有生效。因為.editorconfig格式化高于編譯器的格式化規則,導致Prettier定義的格式化沒生效。沒有生效原因可參考EditorConfig-優先級

{
  "semi": false,
  "printWidth": 140,
  "singleQuote": true,
  "trailingComma": "none",
  "arrowParens": "avoid"
}
Prettier格式化規則
3、項目添加ESlint
  • vue add @vue/eslint
  • 選擇StandardLint on Save
    添加ESlint
4、 修改報錯信息

??修改報錯信息有兩種,一種是忽略文件檢查,隱藏報錯信息;第二種是根據報錯信息規則修改。以下提供兩種方式二選其一即可

  1. 忽略文件檢查,隱藏報錯信息
忽略整個文件檢查,一般寫在文件頭部
/* eslint-disable */
忽略單行檢查
/* eslint-disable-line */
忽略下一行檢驗
/* eslint-disable-next-line */
忽略多行檢查
/* eslint-disable */
// js code
/* eslint-enable */
忽略具體錯誤類型 
/* eslint-disable-line [錯誤類型] */
忽略具體錯誤類型

忽略下一行檢驗
  1. 根據報錯信息進行修改
  • 沒有用駝峰命名
  • 沒有用強等===或強不等!==
  • 框架代碼本身有誤
解決方式:為了框架能正確運行,如果是框架本身的報錯信息,用忽略文件或單行文件進行修改,自己寫的代碼嚴格遵循ESlint規范。
框架代碼本身有誤
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370