jig-cli

JIG: コマンドライン版

以下のドキュメントを出力するコマンドラインツールです。

Getting Started

Gradleを使用したシンプルなJavaプロジェクトを想定した手順です。 Mavenなど他のビルドツールを使用していたり、ソースやターゲットディレクトリを変更している場合などは設定が必要になります。

1. JIGのダウンロード
2. プロジェクトのビルド
3. JIGの実行

JIGのダウンロード

直近のリリースから jig-cli.jar をダウンロードしてください。

プロジェクトのビルド

対象プロジェクトをビルドします。

$ cd {対象プロジェクトのディレクトリ}
$ gradle clean build

JIGの実行

プロジェクトのルートディレクトリで実行します。

$ java -jar {JIGをダウンロードしたディレクトリ}/jig-cli.jar

./build/jig ディレクトリにJIGドキュメントが出力されます。 コードを変更したら、再度プロジェクトのビルドから実行してください。

設定

JIG 自身の設定（jig.*）は以下の優先順位（上が優先）で解決されます。

1. CLI 引数（--jig.document.types=PackageRelation,ListOutput のように指定）
2. システムプロパティ（-Djig.document.types=... のように指定）
3. 環境変数（JIG_DOCUMENT_TYPES=... のように、キーを大文字化し . を _ に置換した名前）
4. {user.dir}/jig.properties
5. {user.home}/.jig/jig.properties
6. コード内デフォルト

不正な値（存在しないドキュメント種別、不正な言語タグ、不正な正規表現など）が指定された場合は、警告で無視せずエラーで停止します（fail-fast）。

Spring Boot 由来の設定（ログレベルや読み込みディレクトリ）は application.yml を参照してください。

困ったら

HELP を参照してみてください。