Archimaid は何をしますか?
Archimaid は、Mermaid に ArchiMate 3.2 を archimate-beta 図タイプとして追加します。図をプレーンテキストで記述し、archimaid CLI でチェックして、SVG にレンダリングします。
ワークフロー
- ビューに必要な ArchiMate 要素とリレーションシップを決定します。モデルは、ノートではなく要素タイプとリレーションシップで意味を表現します。
.mmdファイル、または Markdown のフェンスで囲まれたmermaidブロックに図を記述します。- 検証してすべてのエラーを修正し、再度検証します。
標準入力の検証にはnpx --yes archimaid validate path/to/diagram.mmd-を使用します。問題はfile:line:column: messageとして出力されます。警告はwarning:で始まり、実行は失敗しません。 - ArchiMate 3.2 がソースとターゲットタイプ間の各リレーションシップを許可しているか確認します(付録 B)。バリデーターはまだこれをチェックしません。
- GitHub Markdown など、ターゲットホストがプラグインを読み込めない場合は SVG をレンダリングします(「レンダリング」を参照)。
構文
archimate-beta で始め、各行に 1 つの宣言を記述します。
archimate-beta
direction LR
accTitle: Order management
accDescr: The order management suite contains a billing component.
element applicationComponent suite "Order management suite" {
element applicationComponent billing "Billing"
}
description billing "Handles invoicing."
click billing href "https://wiki.example.com/billing" "Open the billing runbook"
suite *-- billing
note review "Confirm retry behaviour" on suite
- 要素:
element <type> <id> "名前"。60 のタイプキー(businessProcess、applicationComponent、nodeなど)は references/reference.md にリストされています。キーがわからない場合はいつでも参照してください。 - ID: 一意で、文字またはアンダースコアで始まり、文字、数字、アンダースコア、ハイフンを含みます。
- 文字列: JSON 形式の二重引用符で、空にしないでください。改行には
\nを使用します。長い名前は自動的に折り返されます。 - アクセシビリティ: 常に
accTitle:を追加します。accDescr:または複数行の場合はaccDescr { … }を追加します。 - フロントマター:
---行で囲まれた YAML ブロックを先頭に記述できます(例:config: { theme: dark })。
リレーションシップ
省略形: <source> <connector> <target>。オプションで : "ラベル" を付けます。左側のエンドポイントは常にモデルのソースです。
| コネクタ | リレーションシップ |
|---|---|
*-- | 構成 |
o-- | 集約 |
@==> | 割り当て |
| `.. | >` |
--> | サービス提供 |
.. / <.. / ..> / <..> | アクセス: 未指定 / 読み取り / 書き込み / 読み書き |
-.-> | 影響 |
--- / --/ | 関連: 無方向 / 方向付き |
==> | トリガー |
-.=> | フロー |
| `-- | >` |
manage <.. orderは manage が order を読み取る ことを意味します: アクセス側は左側にあります。- 文の先頭にある ID は
o--グリフとして読み取られません。o o-- bのように記述し、o--bとは記述しません。 - 同一の省略形の行を繰り返さないでください。
- 長形式:
relationship <type> <id> <source> -> <target>。オプションでaccess read|write|readWrite|unspecifiedまたはdirectedを続け、次にlabel "テキスト"を続けます。他の宣言がリレーションシップの ID を参照する必要がある場合は、長形式を使用します。
ネスト
element … {と}の内側に子を宣言し、各行に 1 つずつ記述します。ブロックはネストでき、要素、説明、リレーションシップ、ノート、nest、clickを含めることができますが、図の設定は含めません。- ネストにはリレーションシップは必要ありません。子と親の関係をサポートするリレーションシップが 1 つだけの場合、その囲みがそれを表し、その行は非表示になります。構成、集約、割り当て、実現、アクセスは親から子へ向かいます。特殊化は子から親へ向かいます。
nest <child> in <parent> [via <relationshipId>]が行形式です。複数のリレーションシップがネストをサポートする可能性がある場合はviaを使用します。各子は 1 つの視覚的な親を持ち、ネストはサイクルを形成してはいけません。
ノートとリンク
note <id> "テキスト"はスタンドアロンのノートを宣言します。on <elementId>を追加して要素に添付します。ノートはリレーションシップのエンドポイントになることができます。click <id> href "<url>" ["ツールチップ"] [_blank|_self|_parent|_top]は要素をリンクします。URL は http、https、mailto、または相対パスである必要があります。ツールチップがない場合、ホバー時にdescriptionが表示されます。
レイアウト
- デフォルト、または
layout architecture:レイヤーを上から下に配置します(戦略、ビジネス、アプリケーション、テクノロジーと物理、実装&移行)。モチベーションは接続先の近くの上部に配置されます。クロスレイヤービューにはこれが推奨されます。 layout framework:同じレイヤーで、固定された受動的構造、振る舞い、能動的構造の列と、右側にモチベーションを配置します。layout graph、または単独のdirection TB|BT|LR|RL:リレーションシップに基づく配置。小さな単一レイヤービューやチェーンにはこれが推奨されます。
対象外
ジャンクション、エンドポイントとしてのリレーションシップ、代替図形、ビューポイント、モデル交換はサポートされていません。これらの構文を発明しないでください。その旨を伝え、最も近いサポートされている構造を使用してください。
レンダリング
レンダリングには、プロジェクト内に Playwright Chromium が必要です。
npm install --save-dev archimaid mermaid playwright
npx playwright install chromium
npx archimaid render diagram.mmd diagram.svg --theme default --background theme
プラグインを登録しないホスト(GitHub、GitLab)の場合は、.mmd ソースを SVG と一緒にコミットし、SVG を埋め込みます: 。
ウェブページの場合は、Mermaid 12.3 以降でプラグインを登録します。
import mermaid from 'mermaid';
import { archimate } from 'archimaid';
mermaid.initialize({ startOnLoad: false, securityLevel: 'strict' });
await mermaid.registerExternalDiagrams([archimate]);
構文を素早く確認するには、ブラウザのプレイグラウンド(https://try.archimaid.org)をユーザーに案内します。
例
references/examples.md には、完全で有効な 3 つの図が含まれています。
- 注文管理: 割り当て、実現、サービス提供、読み取りアクセス
- クロスレイヤーリレーションシップ: ネストされた請求処理を含むアーキテクチャレイアウト
- ネストされたコンポーネント: 構成、添付ノートとスタンドアロンノート、境界を越えたフロー