ESLint:提供linting規(guī)則

2018-09-28 11:48 更新

ESLint

注意:在開始之前,請(qǐng)確保您的計(jì)算機(jī)上有Node.js.

IntelliJ IDEA與ESLint集成 ,帶來了各種各樣的linting規(guī)則,也可以通過插件進(jìn)行擴(kuò)展。當(dāng)您輸入時(shí),IntelliJ IDEA會(huì)在編輯器中顯示ESLint報(bào)告的警告和錯(cuò)誤。使用ESLint,您還可以使用JavaScript標(biāo)準(zhǔn)樣式。

在IntelliJ IDEA中安裝,啟用和配置ESLint

  1. 打開內(nèi)置的IntelliJ IDEA 終端(Alt+F12)并輸入在命令提示符下npm install eslint --save-dev或npm install eslint -g。
  2. (可選)安裝其他插件。
  3. 在“設(shè)置/首選項(xiàng)”對(duì)話框(Ctrl+Alt+S)中,選擇“語言和框架”下的“JavaScript” ,然后在“代碼質(zhì)量工具”下選擇“ESLint”。在打開的ESLint頁面上,選中“啟用”復(fù)選框。之后,頁面上的控件變?yōu)榭捎谩?/li>
  4. 在Node Interpreter字段中,指定Node.js的路徑。如果您遵循標(biāo)準(zhǔn)安裝過程,IntelliJ IDEA會(huì)檢測(cè)路徑并填寫字段本身。
  5. 在“ESLint包”字段中,指定eslint或standard包的位置。
  6. 選擇要使用的配置。
    • 使用自動(dòng)搜索,IntelliJ IDEA會(huì)查找.eslintrc文件或嘗試檢測(cè)在package.json的eslintConfig中定義的配置。IntelliJ IDEA首先在文件夾中查找.eslintrc或package.json,其中文件要連接,然后在它的父文件夾,并依此類推,直到該項(xiàng)目的根。如果搜索失敗,ESLint將使用其默認(rèn)的嵌入式配置文件。
    • 選擇“配置文件”以使用自定義文件,并在“路徑”字段中指定文件位置。
  7. 可選:
    • 在“額外的ESLint選項(xiàng)”字段中,指定運(yùn)行ESLint的其他命令行選項(xiàng),使用空格作為分隔符。
    • 在“附加規(guī)則目錄”字段中,使用其他代碼驗(yàn)證規(guī)則指定文件的位置。這些規(guī)則將在.eslintrc或上面指定的自定義配置文件的規(guī)則之后應(yīng)用,并相應(yīng)地覆蓋它們。

從ESLint導(dǎo)入代碼樣式

您可以將某些ESLint代碼樣式規(guī)則導(dǎo)入IntelliJ IDEA JavaScript代碼樣式設(shè)置。這使IntelliJ IDEA能夠在自動(dòng)完成,生成或重構(gòu)代碼或添加import語句時(shí)為您的項(xiàng)目使用更準(zhǔn)確的代碼樣式選項(xiàng)。當(dāng)您使用“重新格式化”操作時(shí),IntelliJ IDEA將不再從ESLint透視圖中斷開格式正確的代碼。

IntelliJ IDEA了解所有官方格式的ESLint配置:.eslintrc JSON文件, 包含該eslintConfig字段的package.json文件,以及JavaScript和YAML配置文件。

  • 當(dāng)您第一次打開項(xiàng)目時(shí),IntelliJ IDEA會(huì)自動(dòng)從項(xiàng)目ESLint配置中導(dǎo)入代碼樣式。
  • 如果更新了ESLint配置(手動(dòng)或從版本控制中更新),請(qǐng)?jiān)诰庉嬈髦袑⑵浯蜷_,然后在上下文菜單中選擇“應(yīng)用ESLint代碼樣式規(guī)則”:
    從JavaScript或YAML配置文件導(dǎo)入ESLint代碼樣式規(guī)則
    或者,只需在文件頂部的“從ESLint應(yīng)用代碼樣式?”問題上回答“是”:
    IntelliJ IDEA建議從ESLint導(dǎo)入代碼樣式
    應(yīng)用規(guī)則列表顯示在“事件日志”工具窗口中:
    事件日志工具窗口顯示已應(yīng)用的ESLint規(guī)則列表 

使用JavaScript Standard樣式

您可以將JavaScript Standard樣式設(shè)置為應(yīng)用程序的默認(rèn)JavaScript代碼樣式,以便在輸入代碼或重新格式化代碼時(shí)應(yīng)用其主要規(guī)則。由于Standard基于ESLint,您還可以通過IntelliJ IDEA ESLint集成使用Standard。

安裝JavaScript Standard

  • 打開內(nèi)置的IntelliJ IDEA終端(Alt+F12)并在命令提示符下輸入:npm install standard --save-dev。

通過ESLint啟用Standard的linting

  1. 在“設(shè)置/首選項(xiàng)”對(duì)話框(Ctrl+Alt+S)中,選擇“語言和框架”下的“JavaScript” ,然后在“代碼質(zhì)量工具”下選擇“ESLint”。
  2. 在打開的ESLint頁面上,選中“啟用”復(fù)選框,并在“ESLint包”字段中指定standard包的位置。

將JavaScript Standard樣式設(shè)置為默認(rèn)值

  1. 在“設(shè)置/首選項(xiàng)”對(duì)話框(Ctrl+Alt+S)中,選擇:編輯器|代碼樣式|JavaScript。
  2. 關(guān)于代碼樣式。打開的JavaScript頁面,單擊“設(shè)置自”,然后選擇:預(yù)定義樣式|JavaScript Standard樣式。該樣式將取代您當(dāng)前的方案。
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)