jamcha

JAva Method Call Hierarchy Analyzer

このリポジトリは tdcyamadaya/jamcha のフォークです。

変更点

• Update JavaParser to version 3.26.4
• GradleからMavenに移行
• Dockerファイル関連を削除
• GitHub Actionsワークフロー削除（.githubディレクトリを削除）

概要

コードレビューを補助するために、 Java ソースコードを解析してメソッドの呼び出し階層を再帰的に分析可能なテーブルを出力する コマンドラインツールです。

このツールを使って得られた出力を活用することで、以下のようなレビューの補助を行うことができます。

• 特定のメソッドの全ての呼び出し元をリスト化する
• 特定のメソッドが呼び出している全てのメソッドをリスト化する

このツールは JavaParser を用いてソースコードを解析しています。

ツール入出力例

入力ファイル: 複数の Java ソースコード

出力ファイル: 複数の CSV ファイル

出力ファイルについて

出力ファイルの内容については、 こちらのドキュメント を参照してください。

ビルド

./mvnw package で依存関係を含む jar ファイルを作成してください。 jar ファイルは target ディレクトリに出力されます。

• 通常のJAR: target/jamcha-0.0.1.jar
• 依存関係を含むfat JAR: target/jamcha-0.0.1-all.jar

実行

$ java -cp target/jamcha-0.0.1-all.jar jp.co.tdc.jamcha.cmd.Main \
  -i "解析ソースディレクトリ1" "解析ソースディレクトリ2" ... "解析ソースディレクトリn" \
  -s "依存ソースディレクトリ1" "依存ソースディレクトリ2" ... "依存ソースディレクトリn" \
  -l "依存ライブラリディレクトリ1" "依存ライブラリディレクトリ2" ... "依存ライブラリディレクトリn" \
  -o "出力ディレクトリ"

解析ソースディレクトリ: 解析するソースコードが含まれるディレクトリを指定してください。 複数のディレクトリを指定することができます。 特定のパッケージのソースコードだけを分析したい場合は、 該当するパッケージのディレクトリのみを指定することが可能です。

依存ソースディレクトリ: 完全なクラス名やメソッド名を解決するために、依存関係にあるソースコードが含まれるディレクトリを指定してください。 複数のディレクトリを指定することができます。 基本的には、解析対象のソースコードもこの依存ソースディレクトリに指定してください。

依存ライブラリディレクトリ 完全なクラス名やメソッド名を解決するために、 依存関係にある jar ファイルが含まれるディレクトリを指定してください。 複数のディレクトリを指定することができます。

出力ディレクトリ 出力ファイルを格納するディレクトリを指定してください。 ディレクトリが存在しない場合は自動的に作成します。