GlitchFlow
処理の流れと、各時点のDB・FILEの期待状態を一枚の図に。
.glfをVS Codeで開くと、メッセージ、処理、分岐、データの状態を同じ時間軸で確認できる。

入力補助・構文チェック・importによる定義の分割と、PNG/SVGエクスポートも使える。

3ステップで試す
- VS Codeの拡張機能で
GlitchFlowをインストールする。
- 次の内容を
hello.glfとして保存する。
- VS Codeで開き、右側のプレビューを確認する。
title: "はじめてのフロー"
Object FE as "画面" type APP
Object BE as "API" type API
Global ->> FE: 開始
FE+
FE ->> BE: データを取得
BE+
FE <-- BE: 取得結果
BE-
FE-

図の見方: 左からObject、上から下へ処理順。
同じ入力はhello.glfからも取得できる。
保存した.glfは自動でプレビューされ、編集すると図も更新される。
構文や参照の誤りはVS CodeのProblemsに表示される。
記法の早見表
| 書き方 |
図での表示 |
title: "名前" |
プレビューの見出し |
Object ID as "表示名" type APP |
Objectとライフライン |
FE ->> BE: 要求 / FE -> BE: 通知 |
同期 / 非同期メッセージ |
FE <-- BE: 応答 |
応答メッセージ |
FE+ / FE- |
活性区間の開始 / 終了 |
FE: 処理 / FE: *重要な処理* |
処理 / 強調された処理 |
schema DB.users: / state DB.users: |
DBのカラム / 期待状態 |
state FILE: / sql DB: |
ファイルツリー / 表示用SQL |
alt: / opt 条件: / loop 条件: |
分岐 / 条件付き処理 / 繰り返し |
par: / break 条件: |
並列区画 / 中断区画 |
import "./common.glf" |
別ファイルのObjectとschemaを参照 |
titleは最初の非空行に記述し、ブロックは4個の空白でインデントする。
Objectの種別にはAPP、API、DB、FILE、FEATURE、MODULEを指定できる。
stateとsqlは表示用であり、DBやファイルの操作は実行しない。
記法の表示例
以下は各記法を使って取得した実際のプレビューである。
title
最初の非空行に書いたタイトルがプレビューの見出しになる。

Object
宣言したObjectは表示名と種別を持つ枠になり、その下にライフラインが伸びる。

同期 / 非同期メッセージ
->>は同期メッセージ、->は非同期メッセージを表す。

応答メッセージ
FE <-- BEはBEからFEへ戻る破線の応答になる。

活性区間
BE+からBE-まで、BEのライフラインに活性区間が表示される。

通常 / 強調された処理
FE: 処理は通常のカード、FE: *重要な処理*は強調されたカードになる。
2行目以降は4個の空白で下げる。
FE: 通常の処理
内容を確認
FE:
本文の1行目
本文の2行目
FE: *重要な処理
入力を確認*

DBのカラム / 期待状態
schemaはカラム名と型を定義し、stateは指定した時点の行を表示する。
+で追加した行は赤字になり、カラム名にHoverすると型を確認できる。
schema DB.users:
id: int
name: text
state DB.users:
[1, "太郎"]
+ [2, "次郎"]


FILEツリー / 表示用SQL
state FILEはファイルツリーを表示する。
+は追加、-は削除を示す。
state FILE:
users/
+ report.json
- old.json

sql DBは図中にSQLを表示する。
sql DB:
SELECT id, name
FROM users

alt / opt / loop
altはcaseとelseを別の区画に表示する。
alt:
case 成功:
FE ->> BE: 保存
else:
FE: エラーを表示

opt 条件:は条件が成立した場合の処理を囲む。

loop 条件:は繰り返す処理を囲む。

par / break
parは複数のcaseを並列の区画として表示する。
par:
case 画面更新:
FE: 表示を更新
case 記録:
BE: 履歴を記録

break 条件:は中断する場合の処理を囲む。

import
別ファイルに定義したObjectとschemaを取り込み、フローから参照できる。
flow.glf:
import "./common.glf"
Object FE as "画面" type APP
FE ->> DB: 検索
state DB.users:
[1, "太郎"]
common.glf:
Object DB as "共有DB" type DB
schema DB.users:
id: int
name: text

状態と分岐を一緒に見る
セッション隔離のサンプルでは、更新前後のDB、SQL、監査ファイル、成功・失敗の分岐を表示する。

- 図の見方: 緑の表はDB、橙のツリーはFILE、赤い枠は分岐。
- DB:
activeからisolatedへ更新したセルだけを赤字で表示。
- FILE: 追加した
S-42.jsonを赤字で表示。
- 分岐:
altの成功経路と失敗経路を別の区画に表示。
VS Codeでの操作
| やりたいこと |
操作 |
| プレビューを開く |
.glfを開く / エディタ右上のアイコン / GlitchFlow: プレビューを開く |
| 図から記述へ移動 |
図のメッセージ・処理・Stateなどをクリック |
| 定義へ移動 / 参照を検索 |
Object IDやDBテーブル参照でF12 / Shift+F12 |
| 型や種別を見る |
DSLのObject・テーブル、図のDBカラム名にHover |
| 入力を補完 |
VS Codeの補完操作で構文や宣言済みIDを選択 |
| 図を拡大・縮小 |
プレビュー左上の- / Reset / + |
| 画像を保存 |
プレビューのエクスポートアイコン / GlitchFlow: 図をエクスポート |
画像はPNGまたはSVGで、スクロール外を含む図全体を保存できる。
解析エラーがある間は、最後に正常に描画できた図を保持する。
設定
| 設定 |
既定値 |
内容 |
glitchflow.preview.autoOpen |
true |
.glfを開いたときの自動プレビュー |
glitchflow.syntaxHighlighting |
theme |
theme: VS Codeの配色 / glitchflow: 専用配色 |
さらに試す
開発
Node.js 24とnpmを使用する。
npm ci
npm run build
npm run check
VS Codeでリポジトリを開き、F5でExtension Development Hostを起動する。
視覚テストはnpm run test:visual、拡張機能の統合テストはnpm run test:extensionで実行する。
リポジトリ / 不具合の報告