OSS探訪GitHubでログイン

Java sourceをcoding standardとbest practice ruleで検査しCIで規約違反を止める

OSS規模スコア 332.6OSS健全度 100
スコアの見方

OSS規模スコアはStars・Watchers・Forks・Contributorsを対数圧縮して重み付けした現在の規模指標(上限なし)です。発掘スコアは現在のOSS規模スコアから発掘時点のOSS規模スコアを引いた値、更新ペースは直近30日Commit数、成長モメンタムは直近の観測期間におけるOSS規模スコア差、OSS健全度は取得できた更新状況・Community Health・Releaseの0〜100評価です。

Stars
9,590
主要言語
Java
ライセンス
LGPL-2.1
リポジトリ最終更新
2026/10/05
ページ内ナビ

概要

CheckstyleはJava source codeがcoding standardやbest practiceに従っているかを検査するcode quality toolです。Google Java Style GuideやSun Code Conventionsを基点にしつつ、XML configurationでcheckを細かく組み替えられます。

特徴と向いている用途

公式資料に基づく紹介・実機未検証 · 内容確認日:

主な特徴

Java sourceをconfigurable rule setで検査する

READMEはcoding standardやbest practiceへの準拠を保証するtoolと説明し、configuration fileでChecker/TreeWalker配下のcheckを組み合わせる例を示しています。

出典:[2]

CLIとbuild pipelineから同じruleを実行する

release artifactやMaven Centralから導入でき、command-line実行をCIへ組み込んでlocal/CIで同じcoding ruleを適用できます。

出典:[2]

向いている用途

teamのJava coding conventionを自動化したいprojectに向く

formatだけでなくimport、control flow、class/member構造等のruleをrepository内設定として固定し、review前に機械的な違反を検出したい場合に有効です。

出典:[2]

導入前の確認

rule upgradeによる新規violationを段階的に取り込む

Checkstyleのupgradeではrule追加やbehavior変更により既存codeで新しいviolationが出る可能性があります。14.3.0ではJava moduleとしてのmodule-info.java対応が追加されています。

出典:[3]

参考にした公式資料

  1. [1]checkstyle/checkstyle — GitHub repository(2026-10-06)
  2. [2]Checkstyle — README(2026-10-06)
  3. [3]Checkstyle 14.3.0 release(2026-10-06)
編集部からの補足

命名・layout・import・control flow等のcoding ruleをteam規約としてCIへ固定したい場合に向きます。SpotBugsやPMDのbug/design analysisとは目的が異なるため、役割を分けて併用できます。

3ステップで試す

  1. 1

    ソースを取得

    git clone --depth 1 https://github.com/checkstyle/checkstyle.git
  2. 2

    リポジトリへ移動

    cd checkstyle
  3. 3

    公式手順を確認

    READMEのInstallation / Quick Start / Getting Startedにある公式コマンドを続けて実行してください。

    find . -maxdepth 1 -iname 'README*' -exec sed -n '1,220p' {} \; -quit
公式READMEで確認

成長

成長の推移 · 直近30日

9,590 Stars

推移データを蓄積中です。

Built with

カテゴリとタグ

GitHubデータ

GitHubのデータGitHubの詳細データを見る

GitHub Topics

  • code-quality
  • command-line-tool
  • hacktoberfest
  • java
  • static-analysis
  • static-code-analysis
Stars
9,590
Forks
4,266
Watchers
9,590
Open Issues
759
Contributors
377
所有者種別
Organization
主要言語
Java
ライセンス
LGPL-2.1
リポジトリ最終更新
2026/10/05

このOSSの使い方や活用事例をMarkdownで投稿できます。管理者が承認した後に公開されます。

情報の誤りを報告

掲載内容に誤りや古い情報があればお知らせください。

このページを読んで、次に何をすればよいか分かりましたか?