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

注: Closure Linter の Windows サポートは試験運用です。

スタイルの問題を検出する

単一のファイルで 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 フラグ

Closure Linter で、スペーシング、JsDoc 型、author タグなどのスタイル ルールをより厳密に適用する場合は、--strict コマンドライン フラグを使用します。Closure Library にコードを投稿する場合は、--strict を使用する必要があります。

スタイルの問題を修正する

上記のコマンドのいずれかで、gjslint を fixjsstyle に置き換えると、gjslint がチェックするエラーの多くが自動的に修正されます。

次に例を示します。

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

fixjsstyle を使用する前に、スクリプトが不要な変更を行う場合に備えて、ファイルをバックアップするか、ソース管理システムに保存する必要があります。