利用ESLint檢查代碼質量

 1. ESLint  

  ESLint 是一個插件化的 javascript 代碼檢測工具,它能夠用於檢查常見的 JavaScript 代碼錯誤,也能夠進行代碼風格檢查,這樣咱們就能夠根據本身的喜愛指定一套 ESLint 配置,而後應用到所編寫的項目上,從而實現輔助編碼規範的執行,有效控制項目代碼的質量javascript

  第一步 經過cnpm安裝   $ cnpm install -g eslint
java

  

  上面是須要測試的代碼。 咱們輸入 node mes.js 就是文件的名字。會輸出{a: 123,b:456};
node

  接着執行eslint來執行檢查代碼 $ eslint mes.js。 可是沒有輸出任何信息。這是由於咱們沒有指定任何的配置,除非這個文件是有語法錯誤,不然應該是不會有任何提示的。如今咱們先使用內置的eslint:recommended配置,它包含了一系列核心規則,能報告一些常見的問題。
npm

  首先新建 ESLint 配置文件.eslintrc.js瀏覽器

  

  接下來咱們能夠看到輸出的錯誤工具

  

  第 1 條提示,咱們能夠禁用no-console規則。將配置文件.eslintrc.js改成這樣:測試

  配置規則寫在rules對象裏面,key表示規則名稱,value表示規則的配置,具體說明見下文。編碼

  JavaScript 有不少種運行環境,好比常見的有瀏覽器和 Node.js,另外還有不少軟件系統使用 JavaScript 做爲其腳本引擎,好比 PostgreSQL 就支持使用 JavaScript 來編寫存儲引擎,而這些運行環境可能並不存在console這個對象。另外在瀏覽器環境下會有window對象,而 Node.js 下沒有;在 Node.js 下會有process對象,而瀏覽器環境下沒有。因此在配置文件中咱們還須要指定程序的目標環境spa

  

  再執行檢查的時候就沒有錯誤了。插件

  每條規則有 3 個等級:offwarnerroroff表示禁用這條規則,warn表示僅給出警告,並不會致使檢查不經過,而error則會致使檢查不經過。

 2. 使用共享的配置文件

  上文咱們以eslint:recommended爲基礎配置,而後在此之上修改no-console這條規則。而在大多數時候,咱們可能會根據本身我的或團隊的習慣,定製更多的規則,好比限定縮進是 2 個空格和使用單引號的字符串等。而若是每個項目都要這樣寫到.eslintrc.js文件上,管理起來會比較麻煩。咱們能夠將定義好規則的.eslintrc.js文件存儲到一個公共的位置,好比public-eslintrc.js

  

相關文章
相關標籤/搜索