/jig

Primary LanguageJavaApache License 2.0Apache-2.0

JIG

MavenCentral CircleCI GitHubActions

banner

JIGはコードでの設計を支援するツールです。思い浮かんだ設計をコーディングすればいい感じに可視化される世界を目指しています。

主にバイトコード(classファイル)から一覧や図を出力します。バイトコードが対象なので、JVM言語であれば主要機能は動作します。

サンプル

サンプルリポジトリ を参照してください。

使い方

実行方法はコマンドラインとGradleプラグインがあります。それぞれのREADMEを参照してください。

実行には Java11以降 と Graphviz が必要です。 より詳しい情報はWikiを参照してください。 うまく動かない場合などは issue でお問い合わせください。

コンセプト

三層+ドメインモデルのアーキテクチャで実装されたコードから、以下の分析・設計情報を生成します。

  • ドメインモデルのクラスに記述された業務の概念とビジネスルール
  • アプリケーション層に記述された業務機能

想定するアーキテクチャ

三層+ドメインモデルのアーキテクチャでの使用を想定しています。

ドメインモデルのクラスに記述された業務の概念とビジネスルール

アプリケーション層に記述された業務機能

JIGドキュメント

JIGの生成する分析・設計情報をJIGドキュメントと呼んでいます。

LICENSE

Apache License 2.0