團隊協(xié)作—Eslint使用

.eslintrc.js 文件

先了解一下 eslint 最重要的文件 .eslintrc.js辫呻,這個文件用于描述編碼規(guī)范。

// .eslintrc.js 
module.exports = {
  "extends": "airbnb",
  "rules": {
    "semi": [2, "never"],
    "no-console": 0,
    "comma-dangle": [2, "always-multiline"],
    "max-len": 0,
    "react/jsx-first-prop-new-line": 0,
    "react/jsx-filename-extension": 0,
    "space-before-function-paren": [2, "always"],
    "no-unused-expressions": [0, {
      "allowShortCircuit": true,
      "allowTernary": true
    }],
    "arrow-body-style": [0, "never"],
    "func-names": 0,
    "prefer-const": 0,
    "no-extend-native": 0,
    "no-param-reassign": 0,
    "no-restricted-syntax": 0,
    "no-eval": 0,
    "no-continue": 0,
    "react/jsx-no-bind": 0,
    "no-unused-vars": [2, { "ignoreRestSiblings": true }],
    "no-underscore-dangle": 0,
    "global-require": 0,
    "import/no-unresolved": 0,
    "import/extensions": 0,
    "jsx-a11y/href-no-hash": 0,
    "react/no-array-index-key": 0,
    "react/require-default-props": 0,
    "react/forbid-prop-types": 0,
    "react/no-string-refs": 0,
    "react/no-find-dom-node": 0,
    "import/no-extraneous-dependencies": 0,
    "import/prefer-default-export": 0,
    "react/no-danger": 0,
    "jsx-a11y/no-static-element-interactions": 0,
  },
  "parser": "babel-eslint",
  "parserOptions": {
    "sourceType": "module",
    "ecmaVersion": 8,
    "ecmaFeatures": {
      "jsx": true,
      "experimentalObjectRestSpread": true
    }
  },
  "settings": {
    "import/resolver": "node"
    }
};

Eslint 是什么

統(tǒng)一的編碼規(guī)范夭拌。Lint 是檢驗代碼格式工具的一個統(tǒng)稱小作,具體的工具有 Jslint 砾淌、 Eslint 等等,你可以理解為它們是競品之間的關(guān)系具帮。

每個程序員都有自己的編碼習慣博肋,舉個例子:

  • 有的人寫代碼低斋,一行代碼結(jié)尾必須加分號 ;,有的人覺得不加分號 ; 更好看匪凡;
  • 有的人寫代碼膊畴,一行代碼不會超過 80 個字符,認為這樣看起來簡潔明了病游,也有的人喜歡把所有邏輯都寫在一行代碼上唇跨,覺得別人看不懂的代碼很牛逼;
  • 有的人使用變量必然會先定義 var a = 10衬衬;而粗心的人寫變量可能沒有定義過就直接使用 b = 10;买猖;

這些個人習慣會使得團隊協(xié)作產(chǎn)生各種各樣問題,畢竟編碼的行為不統(tǒng)一滋尉,別人的編碼習慣自己很難適應(yīng)玉控。

lint 的由來

如果你寫自己的項目當然怎么折騰都沒關(guān)系,但是在公司中狮惜,老板希望每個人寫出的代碼都要符合一個統(tǒng)一的規(guī)則高诺,這樣別人看源碼就能夠看得懂,因為源碼是符合統(tǒng)一的編碼規(guī)范制定的碾篡,交流起來也會更加順暢虱而。

lint 就是這樣一個自動化檢查工具,它提供提供編碼規(guī)范开泽;提供自動檢驗代碼的程序牡拇,并打印檢驗結(jié)果:告訴你哪一個文件哪一行代碼不符合哪一條編碼規(guī)范,方便你去修改代碼眼姐。

Eslint 安裝

# 創(chuàng)建項目
$ npm init

# 安裝依賴包(Dev environment)
$ npm install eslint -D

設(shè)置 package.json

"scripts": {
    "test": "react-scripts test --env=jsdom",
    "lint": "eslint src", // Lint 應(yīng)該提供自動校驗代碼的程序诅迷,這個腳本就是讓 Lint 自動檢驗 src 目錄下所有的 .js 文件。
    "lint:create": "eslint --init" //用來生成 .eslintrc.js 文件众旗,Lint 提供的編碼規(guī)范就寫在這個文件罢杉,所以我們需要創(chuàng)建它
}

創(chuàng)建 .eslint.js 文件

$ npm run lint:create

> eslint --init

? How would you like to configure ESLint? Answer questions about your style # 以問答的形式創(chuàng)建配置文件
? Are you using ECMAScript 6 features? Yes      # 是否校驗 Es6 語法
? Are you using ES6 modules? Yes                # 是否校驗 Es6 模塊語法
? Where will your code run? Browser             # 代碼運行環(huán)境,Browser 指瀏覽器
? Do you use CommonJS? Yes                      # 是否校驗 CommonJs 語法
? Do you use JSX? Yes                           # 是否校驗 JSX 語法
? Do you use React? Yes                         # 是否校驗 React 語法
? What style of indentation do you use? Tabs    # 首行空白選擇 Tab 鍵還是 Space
? What quotes do you use for strings? Double    # 字符串使用單引號 'string' 還是雙引號 "string"
? What line endings do you use? Windows         # 操作系統(tǒng)
? Do you require semicolons? Yes                # 每行代碼結(jié)尾是否校驗加分號 ;
? What format do you want your config file to be in? JavaScript     # 以 .js 格式生成配置文件
Installing eslint-plugin-react@latest   # 因為要校驗 React 語法贡歧,所以這里需要下載一個 React 語法規(guī)則的包

創(chuàng)建完成后根目錄下就會出現(xiàn) .eslintrc.js 文件

--fix 參數(shù)

"scripts": {
    "test": "react-scripts test --env=jsdom",
    "lint": "eslint src --fix",
    "lint:create": "eslint --init"
}

這里給 "lint": "eslint src --fix", 加上 --fix 參數(shù)滩租,是 Eslint 提供的自動修復(fù)基礎(chǔ)錯誤的功能±洌可惜的是 --fix 只能修復(fù)基礎(chǔ)的不影響代碼邏輯的錯誤律想,比如字符串自動變成了雙引號、給代碼末尾也加上了分號這種绍弟,像 no-unused-vars 這種錯誤只能手動修改技即。

配置文件

參考官方文檔:https://cn.eslint.org/

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市樟遣,隨后出現(xiàn)的幾起案子而叼,更是在濱河造成了極大的恐慌身笤,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,695評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件葵陵,死亡現(xiàn)場離奇詭異液荸,居然都是意外死亡,警方通過查閱死者的電腦和手機脱篙,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,569評論 3 399
  • 文/潘曉璐 我一進店門娇钱,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人绊困,你說我怎么就攤上這事文搂。” “怎么了考抄?”我有些...
    開封第一講書人閱讀 168,130評論 0 360
  • 文/不壞的土叔 我叫張陵细疚,是天一觀的道長。 經(jīng)常有香客問我川梅,道長疯兼,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,648評論 1 297
  • 正文 為了忘掉前任贫途,我火速辦了婚禮吧彪,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘丢早。我一直安慰自己姨裸,他們只是感情好,可當我...
    茶點故事閱讀 68,655評論 6 397
  • 文/花漫 我一把揭開白布怨酝。 她就那樣靜靜地躺著傀缩,像睡著了一般。 火紅的嫁衣襯著肌膚如雪农猬。 梳的紋絲不亂的頭發(fā)上赡艰,一...
    開封第一講書人閱讀 52,268評論 1 309
  • 那天,我揣著相機與錄音斤葱,去河邊找鬼慷垮。 笑死,一個胖子當著我的面吹牛揍堕,可吹牛的內(nèi)容都是我干的料身。 我是一名探鬼主播,決...
    沈念sama閱讀 40,835評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼衩茸,長吁一口氣:“原來是場噩夢啊……” “哼芹血!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,740評論 0 276
  • 序言:老撾萬榮一對情侶失蹤祟牲,失蹤者是張志新(化名)和其女友劉穎隙畜,沒想到半個月后抖部,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體说贝,經(jīng)...
    沈念sama閱讀 46,286評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,375評論 3 340
  • 正文 我和宋清朗相戀三年慎颗,在試婚紗的時候發(fā)現(xiàn)自己被綠了乡恕。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,505評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡俯萎,死狀恐怖傲宜,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情夫啊,我是刑警寧澤函卒,帶...
    沈念sama閱讀 36,185評論 5 350
  • 正文 年R本政府宣布,位于F島的核電站撇眯,受9級特大地震影響报嵌,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜熊榛,卻給世界環(huán)境...
    茶點故事閱讀 41,873評論 3 333
  • 文/蒙蒙 一锚国、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧玄坦,春花似錦血筑、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,357評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至择懂,卻和暖如春喻喳,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背休蟹。 一陣腳步聲響...
    開封第一講書人閱讀 33,466評論 1 272
  • 我被黑心中介騙來泰國打工沸枯, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人赂弓。 一個月前我還...
    沈念sama閱讀 48,921評論 3 376
  • 正文 我出身青樓绑榴,卻偏偏與公主長得像,于是被迫代替她去往敵國和親盈魁。 傳聞我的和親對象是個殘疾皇子翔怎,可洞房花燭夜當晚...
    茶點故事閱讀 45,515評論 2 359

推薦閱讀更多精彩內(nèi)容

  • 為什么要用eslint 每個開發(fā)都有自己的編碼習慣或風格,很難說誰的代碼寫的好看,誰的代碼寫的不好看赤套。對于一個團隊...
    _劉家強閱讀 1,388評論 0 7
  • 兩個月之前在項目中就開始使用 Eslint 飘痛,當時直接 copy 別人的 .eslintrc.js 文件,感覺好復(fù)...
    dkvirus閱讀 112,000評論 33 190
  • 兩個月之前在項目中就開始使用 Eslint 容握,當時直接 copy 別人的 .eslintrc.js 文件宣脉,感覺好復(fù)...
    小雨雪smile閱讀 478評論 0 0
  • 為什么需要規(guī)范標準 軟件開發(fā)需要多人協(xié)同 不同開發(fā)者具有不同的編碼習慣和喜好 不同的喜好增加項目維護成本 每個項目...
    翔子丶閱讀 1,699評論 0 0
  • 一、JSLint JSHint ESLint 參考前端工具考 - ESLint 篇JS Linter 進化史 C ...
    合肥黑閱讀 76,680評論 0 47