序文
Jshintは、JavaScriptコードがコーディングルールに準拠していることを分析および検証するために使用されます。この強力なツールは、コードのエラーや問題を見つけるのに役立ち、チームが特定のコーディングコンベンションとスタイルを維持することを強制し、コードを信頼性が高く読みやすくします。
この記事では、Jshintのインストール、構成、使用方法を紹介します。また、Jshintを使用できる私のお気に入りの編集者の一部をリストする例も含まれています。
jshintをインストールします
Jshintのインストールは非常に簡単で、ノードパッケージマネージャー(NPM)を使用できます。 NPMをまだインストールしていない場合は、nodejs Webサイトから最新バージョンをダウンロードして、node.jsとNPMをインストールできます。
NPMがインストールされたら、次のコマンドを使用してJshintをインストールできます。
npmインストールjshint -g
-gパラメーターは、任意のディレクトリでこのコマンドを呼び出すことができるようにグローバルにインストールしたいことをnpm伝えます。
コマンドラインを介してコードを確認します
Jshintがインストールされたので、コマンドラインのjshintを使用してJavaScriptコードファイルを分析しましょう。
これがファイル名のファイルですdemo1.json:
次のコマンドを使用して、コードを分析します。
jshint demo1.js
Jshintは、demo1.jsファイルの8行目にエラーがあることを示しています。その理由:セミコロンが欠落しています。
不足しているセミコロンを埋めてこのコマンドを再度実行すると、エラーメッセージ出力はありません。
jshintを構成します
Jshintにはコードを分析するデフォルトの構成がありますが、その構成設定は非常に柔軟になるように設計されています。 jshintに構成処理ファイルを提供する4つの方法があります。
1つの方法は、 --configパラメーターを使用して構成ファイルを指定することです。
jshint demo1.js -config config.json
別の方法は、Jshintがコード分析のために同じレベルディレクトリでこの構成ファイルを検索するため、構成を.jshintrcというファイルに配置することです。発見されていない場合は、Root Directoryまで上部ディレクトリを検索し続けます。これにより、プロジェクトに異なる構成ファイルを設定できます。
3番目の方法は、構成情報をPackage.jsonファイルのjshintconfigプロパティの下に配置することです。
これらの3つの方法のいずれかで、構成情報はJSON形式で、各パラメーターを指定してJSHINTオプションをオンまたはオフにするように指定します。たとえば、次の構成ファイルの「未使用」と「UNDEF」は、未使用と未定義の変数のアラームをアクティブにすることです。 「Curly」では、常にループと条件付きブロックにブレースを置く必要があります。 「eqeqeq」とは、==および!=が禁止されていることを意味しますが、===および!==を使用する必要があります。 「Globals」は、コードで定義されていないグローバル変数のホワイトリストを指定するために使用されます。
4番目の方法は、Annotationのコードファイルに構成情報を書き込むことです。
さまざまな構成オプションを表示して、Jshintの動作を制御できます。
小さな例
次に、上記のconfig.json configurationファイルのオプションを操作しましょう。以下にJavaScriptファイルがあるとします。これは、学習のみのほんの一部です。
jshintコマンドdemo2.js --config config.jsonを実行すると、次の結果が得られます。
コードには4つのエラーがあります。 9行目で、Jshintは、「if」コードブロックをブレースに包む必要があることを促します。変数subscription_idは定義されていますが、使用されていません。 9行目と11行目では、「確認」と「コンソール」は定義されていません。
ほんの少しの変更で最初の2つのエラーを回避できます。
次に、config.jsonファイルに開発オプションを追加して、Jshintが「確認」と「コンソール」を認識できるようにTRUEに設定します。
この時点で、Jshintコマンドを再度実行すると、エラーはありません。
要約します
Jshintは、コードエラーを減らすための非常に優れたツールです。多くの編集者がJshintサポートを提供しています。興味のある友達はJshintをさらに勉強できます。上記は、Jshintを使用してJavaScriptエラーを減らすことです。 JavaScriptを使用しているすべての人に役立つことを願っています。