注: 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
次のコマンドを実行して、Closure Linter を Mac OS X にインストールします。
$ sudo easy_install pip $ sudo pip install https://github.com/google/closure-linter/zipball/master
Windows
Windows に Closure Linter をインストールするには:
- Windows 用 Python をダウンロードしてインストールします。
- 次のコマンドを実行します。
> pip install https://github.com/google/closure-linter/zipball/master
注: Closure Linter に対する Windows のサポートは試験運用版です。
スタイルの問題の検索
1 つのファイルで 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 アノテーションがないことのチェックが無効になりますが、リンターは既存の JsDoc アノテーションが正しく使用されているかどうかを検証します。
--strict フラグ
スペース、JsDoc タイプ、作成者タグなどのスタイルルールに対して Closure Linter をより厳密に設定するには、--strict コマンドライン フラグを使用します。Closure ライブラリにコードを提供する場合は、--strict を使用する必要があります。
スタイルの問題を修正する
上記のどのコマンドでも、fixjsstyle を gjslint に置き換えると、gjslint によってチェックされるエラーの多くを自動的に修正できます。
例:
$ fixjsstyle path/to/file1.js path/to/file2.js
fixjsstyle を使用する前に、スクリプトで不要な変更が行われた場合に備えて、ファイルをバックアップしたり、ソース管理システムに保存しておく必要があります。