archspec_diagram

archspec_diagramv0.1.0MIT

Draw an Archspec.rb as a Mermaid flowchart

インストール

gem install archspec_diagram

• GitHub のソースコード

archspec_diagram は、Archspec の Archspec.rb を Mermaid のフローチャートとして描きます。 コンポーネントはボックスに、許可された依存と禁止された依存は矢印に、その他の規則はボックスの中のテキストになります。 設定は archspec check と同じように読みますが、コードは解析しないので、Rails を起動する必要がありません。

特徴

• 3 つの形式。 -f mermaid は図だけを出力します。 -f markdown は見出しと凡例の表を加え、-f html は単独で開ける HTML ページを書き出します。
• 詳細度。 --detail names はコンポーネントと矢印だけを描き、既定の rules はセレクターと規則の行を加え、reasons はすべての because: のテキストを加えます。
• 1 つのコンポーネント。 --focus billing は、そのコンポーネントと、それとどちらかの向きでつながるすべてのコンポーネント、プロジェクト全体の規則だけを残します。
• 安全な出力ファイル。 -o は一時ファイルに書いてから名前を変えるので、実行が失敗しても前の図がそのまま残ります。

エージェントでの使い方

コマンドはエラーを、バックトレースではなく stderr の 1 行で出力します。 終了コードは、成功で 0、設定か入出力の問題で 1、使い方の誤りで 2 です。 描画は決定的なので、assert_equal File.read("docs/architecture.mmd"), ArchspecDiagram.render("Archspec.rb") のようなテストは、コミットした図が古くなると失敗します。

はじめかた

archspec_diagram には Ruby 3.2 以降と archspec 1.1.x が必要です。

gem install archspec_diagram
archspec_diagram
archspec_diagram -f markdown -o ARCHITECTURE.md