如何使用 Closure Linter

注意：Closure Linter 已淘汰，且不再於 Google 服務中使用。 如需更多資訊，請參閱這個網頁

本文說明如何安裝及使用 Closure Linter。

安裝 Closure Linter

使用 Python pip 公用程式下載並安裝 Closure Linter。

Linux

若要在 Linux 安裝 Closure Linter，請執行下列指令：

$ sudo apt-get install python-pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Mac OS X

若要在 Mac OS X 上安裝 Closure Linter，請執行以下指令：

$ sudo easy_install pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Windows

如何在 Windows 上安裝 Closure Linter：

1. 下載並安裝 Windows 版 Python。
2. 執行下列指令：

> pip install https://github.com/google/closure-linter/zipball/master

附註：Windows 對 Closure Linter 的支援仍在實驗階段。

尋找風格問題

如要在單一檔案上執行 Closure Linter，請嘗試：

$ gjslint path/to/my/file.js

預期會得到以下結果：

Line 46, E:0110: Line too long (87 characters).
Line 54, E:0214: Missing description in @return tag
Line 66, E:0012: Illegal semicolon after function declaration
Line 150, E:0120: Binary operator should go on previous line "+"
Line 175, E:0011: Missing semicolon after function assigned to a variable
Line 210, E:0121: Illegal comma at end of array literal
Line 220, E:0002: Missing space before ":"

您也可以以遞迴方式檢查整個目錄，如下所示：

$ gjslint -r path/to/my/directory

根據預設，Closure Linter 會檢查是否有正確的 JsDoc 註解。如果您不想檢查專案中缺少 JsDoc 註解，請停用以下檢查：

$ gjslint --nojsdoc -r path/to/my/directory

雖然這個標記停用了缺少 JsDoc 註解的檢查，但 Linter 仍會驗證現有的 JsDoc 註解是否正確使用。

--strict 旗標

如果您希望 Closure Linter 對空格規則、JsDoc 類型和作者標記等樣式規則更嚴格，請使用 --strict 指令列旗標。如果您要將程式碼提供給 Closure Library，就必須使用 --strict。

修正樣式問題

在上述任何指令中，您可以將 fixjsstyle 替換為 gjslint，以自動修正 gjslint 檢查的許多錯誤。

例如：

$ fixjsstyle path/to/file1.js path/to/file2.js

使用 fixjsstyle 前，您應該備份檔案，或是將檔案儲存在來源控制系統中，以防指令碼執行您不必要的變更。