※上記の広告は60日以上更新のないWIKIに表示されています。更新することで広告が下部へ移動します。

Closure Linterの使い方
  • このページは http://code.google.com/intl/ja/closure/utilities/docs/linter_howto.html の日本語訳です。
  • Closure LinterはJavaScriptのコードスタイルがGoogleのスタイルガイドに適合しているかをチェックするツールで、Google自身が提供しています。またエラーを警告するだけでなく、エラー箇所を自動的に修正してくれる機能も持っています。


このドキュメントは Closure Linter のインストールと利用の仕方を解説するものです。

Closure Linter のインストール

Closure Linter のインストールには、Python のeasy_installユーティリティを使ってください。

Linux

LinuxにClosure Linter をインストールするには、以下のコマンドを実行してください。
$ cd /tmp
/tmp$ sudo easy_install http://closure-linter.googlecode.com/files/closure_linter-latest.tar.gz

Mac OS X

Mac OS XにClosure Linter をインストールするには、以下のコマンドを実行してください。
$ sudo easy_install http://closure-linter.googlecode.com/files/closure_linter-latest.tar.gz

Windows

Windowsに Closure Linter をインストールするには:
  1. Windows版Pythonをダンロード、インストールします。
  2. Easy Installをインストールします。
  3. 以下のコマンドを実行します。
> easy_install http://closure-linter.googlecode.com/files/closure_linter-latest.tar.gz
  • 注意 : 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 フラグ

もしスペースの使い方やJsDocの型、@authorタグなどについて Closure Linter により厳格なルールを適用させたければ、--strictコマンドラインフラグを使用してください。またClosure Libraryにコードを寄贈する場合は、--strictを必ず使わなければなりません。

  • 訳注 : --helpフラグを使って、利用可能なオプションの完全なリストを参照することができます。

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

上に示したどのコマンドでも、gjslintfixjsstyleに置き換えると、gjslintによって検出されたエラーの多くを自動的に修正することができます。

例えばこのようにします:
$ fixjsstyle path/to/file1.js path/to/file2.js
fixjsstyleを使用する前に、ファイルをバックアップするか、それらをソース管理システムに保管しておくべきです。あなたが望まないようなかたちでスクリプトが改変されてしまう可能性もあるからです。

  • 訳注 : --helpフラグを使って、利用可能なオプションの完全なリストを参照することができます。