Linter とは？簡単にまとめてみた

はじめに

プログラミングをしていると、コードのミスやスタイルの違いによって、バグの発生や可読性の低下が起こることがあります。
これを防ぐために活用されるのが「Linter（リンター）」です。

本記事では、Linterの基本概念やメリット、代表的なLinterツールについて解説していきます。

Linterとは、ソースコードを解析し、構文エラーやスタイルの問題を検出するツールのことです。
手作業でコードを確認するのは時間がかかりますが、Linterを使うことで自動的に問題点を指摘してくれるため、開発効率が向上します。

プログラミング言語ごとに異なるツールが用意されており、代表的なもので言うとJavaScript の ES Lint などかと思います。

Linterを使うメリットは主に以下の3つかと思っています。

具体的には未使用の変数やタイポ(スペルミス)などのバグを事前に検出できます。

// ESLint の例
function add(a, b) {
    return a + c; // 'c' は未定義の変数
}

console.log(add(2, 3));

このようなコードがあった場合、ESLintで解析すると、'c' is not defined というエラーが発生し、未定義の変数を使っている問題を指摘してくれます。
これにより、実行時エラーが発生する前に問題を修正することができます。

Linterを使用することで、コードの書き方に一貫性を持たせることができます。
例えばですが、JavaScriptでは以下の2つのコードを書いたとしてもエラーにはなりません。

console.log("Hello, " + name); // ダブルクォート & セミコロン

console.log('Hello, ' + name) // シングルクォート & セミコロンなし

どちらも動きますが、見栄えとしてはよろしくないですよね。
Linterを使うことで、コーディングの書き方を統一することができます。

例えば、ESLintでスタイルガイドを設定するには、.eslintrc.json にルールを作成します。

{
    "rules": {
        "indent": ["error", 2],
        "semi": ["error", "always"],
        "quotes": ["error", "double"]
    }
}

設定したルールは以下の通りです。

この設定をあらかじめ用意しておくことで、開発者のコーディングの差異やレビュワーの負担を減らすことができます。

一つ前のメリットの部分でも少し取り上げていますが、プロジェクトメンバーの考慮しなければいけないことを減らすことができます。

例えば、

など、プロジェクトメンバーを簡単で単純な悩み事から解放し、各人の作業に集中させることができます。

デメリットについてもいくつか上げておきます。

Linterのルールが厳しすぎると、実際には問題のないコードにも警告が出ることがあります。

例えば、Go言語でよく用いられる「golangci-lint」など複数のチェックツールをまとめてくれているライブラリを使ったとします。
闇雲に多くのチェックツールをOnにしておくと、制限が厳しくこちらの想定以上に警告が出てしまうことがあります。

大規模なプロジェクトでは、Linterの解析に時間がかかることがあります。
タイプチェックや依存関係の解析などプロジェクトのルールが複雑化し、ファイルが増加するのに比例して解析にも時間は要することになります。

また、開発中にリアルタイムでチェックを行う場合(よく使われるIDEやエディタの拡張機能は基本的にこれ)、
エディタやCI/CDパイプラインの動作が遅くなる可能性があります。

こちらはプロジェクトの定義を作成する側のお話になります。

どのルールを設定するか・どんなルールを設定するかを見誤ると 1. や 2. で挙げたような開発体験の低下を自ら生み出してしまうことになります。

ルールを作成する側に回る場合は取捨選択と利用するLinterの特徴を押さえる必要があるため、理解に時間は要するかと思います。

今回はLinterについて解説しました。

Linterはバグを未然に防ぐために欠かせないツールですが、誤検出も起こり得るため、適切なルールを設定し、必要に応じてカスタマイズすることが重要です。

適切なLinterを導入し、より効率的で品質の高いコードを書いていきましょう！

最後まで目を通していただき、ありがとうございました。