チェックするルール

今回実装するのは次の7ルールだ。どれも「構文だけで判定できる」ものを選んでいる。

ルール ID重要度内容実装方法
EMPTY_CATCHerror(コメントのみなら info)catch ブロックが空木の走査
BROAD_CATCHwarnException・Throwable・RuntimeException をまとめて catchQuery
SYSTEM_OUTwarnSystem.out / System.err への出力Query
PRINT_STACK_TRACEwarnprintStackTrace() の呼び出しQuery
LONG_METHODwarnメソッド本体が30行を超える木の走査
DEEP_NESTINGwarn制御構文の入れ子が3段を超える木の走査
TOO_MANY_PARAMSwarn引数が5個を超える木の走査

「特定の形があるか」は Query が得意で、「深さ・行数・個数を数える」のは Python で木をたどるほうが素直に書ける。両方を1つのツールの中で使い分けるのがポイントだ。

チェッカーの全体

lint.py
"""tree-sitter で作る簡易コードチェッカー(Java)"""
import csv
import sys
from pathlib import Path
from tree_sitter import Query, QueryCursor
from ts_common import JAVA, parser, read_source, text

MAX_METHOD_LINES = 30
MAX_NESTING = 3
MAX_PARAMS = 5

METHOD_NODES = ("method_declaration", "constructor_declaration")
NEST_NODES = {"if_statement", "for_statement", "enhanced_for_statement",
              "while_statement", "do_statement", "switch_expression",
              "try_statement", "catch_clause", "lambda_expression"}

# クエリで書けるルール:(ルールID, 重要度, メッセージ, クエリ)
QUERY_RULES = [
    ("BROAD_CATCH", "warn", "Exception / Throwable をまとめて catch している",
     """(catch_clause (catch_formal_parameter
          (catch_type (type_identifier) @t)) @hit
        (#match? @t "^(Exception|Throwable|RuntimeException)$"))"""),
    ("SYSTEM_OUT", "warn", "System.out / System.err への出力(ロガーを使う)",
     """((method_invocation
          object: (field_access object: (identifier) @_s field: (identifier) @_o)) @hit
        (#eq? @_s "System") (#match? @_o "^(out|err)$"))"""),
    ("PRINT_STACK_TRACE", "warn", "printStackTrace() の呼び出し",
     """((method_invocation name: (identifier) @_n) @hit
        (#eq? @_n "printStackTrace"))"""),
]
COMPILED = [(rid, sev, msg, Query(JAVA, q)) for rid, sev, msg, q in QUERY_RULES]

def method_label(node):
    p = node
    while p is not None and p.type not in METHOD_NODES:
        p = p.parent
    if p is None:
        return ""
    return text(p.child_by_field_name("name"))

def max_depth(node, depth=0):
    """制御構文の入れ子の深さ(ラムダや匿名クラスもまたぐ)"""
    best = depth
    for child in node.named_children:
        d = depth + 1 if child.type in NEST_NODES else depth
        best = max(best, max_depth(child, d))
    return best

def check(path: Path):
    tree = parser.parse(read_source(path))
    root = tree.root_node
    file = path.as_posix()

    for rid, sev, msg, query in COMPILED:
        for node in QueryCursor(query).captures(root).get("hit", []):
            yield (file, node.start_point.row + 1, sev, rid,
                   method_label(node), msg)

    # 構造を数えるルールはノードを直接たどる
    stack = [root]
    while stack:
        node = stack.pop()
        stack.extend(node.named_children)
        if node.type == "catch_clause":
            body = node.child_by_field_name("body")
            stmts = [c for c in body.named_children if "comment" not in c.type]
            if not stmts:
                has_comment = len(body.named_children) > 0
                yield (file, node.start_point.row + 1,
                       "info" if has_comment else "error", "EMPTY_CATCH",
                       method_label(node),
                       "catch がコメントのみ(意図的なら可)" if has_comment
                       else "catch ブロックが空(例外の握りつぶし)")
            continue
        if node.type not in METHOD_NODES:
            continue
        name = text(node.child_by_field_name("name"))
        line = node.start_point.row + 1
        body = node.child_by_field_name("body")
        if body is None:                      # abstract / interface
            continue
        lines = body.end_point.row - body.start_point.row + 1
        if lines > MAX_METHOD_LINES:
            yield (file, line, "warn", "LONG_METHOD", name,
                   f"メソッドが {lines} 行(上限 {MAX_METHOD_LINES})")
        depth = max_depth(body)
        if depth > MAX_NESTING:
            yield (file, line, "warn", "DEEP_NESTING", name,
                   f"入れ子が {depth} 段(上限 {MAX_NESTING})")
        params = node.child_by_field_name("parameters").named_children
        params = [p for p in params if p.type in ("formal_parameter", "spread_parameter")]
        if len(params) > MAX_PARAMS:
            yield (file, line, "warn", "TOO_MANY_PARAMS", name,
                   f"引数が {len(params)} 個(上限 {MAX_PARAMS})")

    if root.has_error:
        yield (file, 1, "error", "SYNTAX_ERROR", "", "構文エラーを含む(結果は参考値)")

def main(src_dir, out_csv):
    rows = []
    for f in sorted(Path(src_dir).rglob("*.java")):
        rows.extend(check(f))
    rows.sort(key=lambda r: (r[0], r[1]))
    with open(out_csv, "w", newline="", encoding="utf-8-sig") as out:
        w = csv.writer(out)
        w.writerow(["file", "line", "severity", "rule", "method", "message"])
        w.writerows(rows)
    for r in rows:
        print(f"{Path(r[0]).name}:{r[1]} [{r[2]}] {r[3]} {r[4]} - {r[5]}")
    print(f"{len(rows)} 件 -> {out_csv}")
    return 1 if any(r[2] == "error" for r in rows) else 0

if __name__ == "__main__":
    sys.exit(main(sys.argv[1], sys.argv[2]))

Query で書くルール

QUERY_RULES の各ルールは、報告したい位置のノードに @hit を付けるという約束で書いている。こうしておくと、ルールを足すときに Query を1つ追加するだけで済み、行番号やメソッド名を出す処理は共通にできる。

たとえば BROAD_CATCH は、catch (Exception e) の型の部分を #match? で調べている。

Query(BROAD_CATCH)
(catch_clause (catch_formal_parameter
   (catch_type (type_identifier) @t)) @hit
 (#match? @t "^(Exception|Throwable|RuntimeException)$"))

catch (IOException | SQLException e) のようなマルチキャッチは、catch_type の下に type_identifier が複数並ぶ。このパターンはそのどれか1つが一致すれば当たるので、catch (IOException | Exception e) も正しく検出される。

空の catch は Query より走査で

空の catch は、最初は Query で (catch_clause body: (block . "{" . "}" .))(波括弧の間に何もない)と書こうとした。ところが、コメントだけが入った catch も一致してしまう。tree-sitter ではコメントは「extras」と呼ばれる特別なノードで、どこにでも現れうるため、アンカーの判定から外れるからだ。

「// 無視してよい と理由が書いてある catch は許したい」という現場は多いので、ここは木をたどって判定している。catch 本体の名前付きの子から line_comment・block_comment を除き、何も残らなければ空と判断する。コメントがあれば重要度を info に下げる。

このあたりの「Query で書けそうで書けない」部分を Python に逃がせるのが、ライブラリとして使う強みである。

数えるルール:長さ・深さ・個数

  • LONG_METHOD:メソッドの body(block)の開始行と終了行の差で数えている。空行やコメント行も含む「見た目の行数」だ。コメントを除いた行数にしたい場合は、本体内のコメントノードの行を引けばよい
  • DEEP_NESTING:max_depth() が、NEST_NODES に含まれるノード(if・for・while・try・catch・ラムダなど)を通るたびに1段深くして、最大値を返す。else if は文法上 if_statement の alternative に次の if_statement が入る形になるので、長い else if の連鎖は深く数えられる点に注意したい
  • TOO_MANY_PARAMS:parameters の子のうち formal_parameter と可変長引数の spread_parameter を数える

どれも child_by_field_name("body") が None のメソッド(abstract メソッドやインターフェースのメソッド)は飛ばしている。

実行と結果

PowerShell / bash
python lint.py sample/src report.csv
実行結果
OrderService.java:27 [warn] SYSTEM_OUT placeOrder - System.out / System.err への出力(ロガーを使う)
OrderService.java:34 [warn] BROAD_CATCH placeOrder - Exception / Throwable をまとめて catch している
OrderService.java:34 [error] EMPTY_CATCH placeOrder - catch ブロックが空(例外の握りつぶし)
3 件 -> report.csv

PART 04 のサンプルに仕込んだ3つの問題がすべて検出された。report.csv は Excel で開いても文字化けしないよう、BOM 付き UTF-8(utf-8-sig)で書いている。

入れ子・引数・コメントのみの catch を含む T.java の結果
T.java:2 [info] EMPTY_CATCH a - catch がコメントのみ(意図的なら可)
T.java:3 [warn] DEEP_NESTING b - 入れ子が 4 段(上限 3)
T.java:3 [warn] TOO_MANY_PARAMS b - 引数が 6 個(上限 5)
3 件 -> t2.csv

入れ子の深いメソッドや引数の多いメソッド、コメントだけの catch を含む別のファイルでは、上のように報告される。

💡 しきい値はプロジェクトに合わせる

30行・3段・5個という値は、新規開発なら妥当でも、長年の資産に当てると大量の警告が出る。最初は既存コードの分布(PART 05 の JSONL で end - start を集計すると早い)を見て、上位数%だけが引っかかる値から始め、徐々に厳しくしていくと運用に乗りやすい。

CI に組み込む

main() は、error が1件でもあれば終了コード1を返す。これを使えば、GitHub Actions などで「空の catch が入ったプルリクエストは失敗にする」といった使い方ができる。

.github/workflows/lint.yml
name: java-lint
on: [pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - run: pip install tree-sitter==0.26.0 tree-sitter-java==0.23.5
      - run: python tools/lint.py src report.csv
      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: lint-report
          path: report.csv
  • パッケージのバージョンは固定しておく。文法パッケージが更新されるとノード型が変わり、Query が QueryError になることがある
  • 既存の違反が多いうちは、変更されたファイルだけを対象にする(git diff --name-only origin/main -- '*.java' の結果を渡す)と導入しやすい
  • 本格的な品質管理には SonarQube などの専用ツールが向いている。当サイトの ツール / コード品質 も参照してほしい。tree-sitter のチェッカーは、それらで表現しにくい プロジェクト固有のルール を補う位置づけがちょうどよい

✅ 次の記事では…

PART 07 では、大きなリポジトリで使うときの速度と並列化、増分パース、COBOL など他言語への応用、そして型解決が必要になったときにどのツールへ切り替えるかをまとめる。

→ PART 07 — まとめへ