@cardenelabs/dragon 0.34.0 → 0.35.0

package/src/compile/hierarchy.ts

@@ -1,92 +0,0 @@
-import type { DslActor, DslDocument } from "../types";
-import { 箱の題 } from "./node-title";
-import { slugify } from "./slug";
-/**
- * 親子の木を扱う小道具 (#2030 で `compile.ts` から移した)。
- *
- * `type: tree` と `type: mind` の 2 図種が使う。 同じ本文を書いた時に、図種を変えただけで
- * 親子の解釈が変わらないようにするため、規則を 1 箇所に置く。
- */
-
-/**
- * 矢印から親子を決める (#1251)。
- *
- * 矢印の先が子で、 どこからも指されない名前が根になる。
- *
- * **黙って上書きしない**。 同じ子に 2 本来たら後勝ちで消えるし、 書いていない名前を指した
- * 矢印は無い親を作る。 どちらも図が静かに変わるので伝える。
- *
- * 親を辿って自分に戻る形は木にならないため、 その枝を切って伝える。
- */
-export function 矢印から親を決める(
-  doc: DslDocument,
-  図種: "tree" | "mind",
-  名前: ReadonlySet<string>,
-  伝える: (名: string, message: string, line?: number) => void,
-): Map<string, string> {
-  const 親 = new Map<string, string>();
-  for (const f of doc.flow) {
-    const 子 = slugify(f.to);
-    const 親名 = slugify(f.from);
-    if (!名前.has(親名)) {
-      伝える(
-        f.from,
-        `type: ${図種} で書いていない名前を親にしています: ${f.from} -> ${f.to}`,
-        f.pos?.line ?? 0,
-      );
-      continue;
-    }
-    // 子の側も見る。 書いていない名前への矢印は、 黙って捨てると図から関係が消える
-    if (!名前.has(子)) {
-      伝える(
-        f.to,
-        `type: ${図種} で書いていない名前を子にしています: ${f.from} -> ${f.to}`,
-        f.pos?.line ?? 0,
-      );
-      continue;
-    }
-    if (子 === 親名) {
-      伝える(f.to, `type: ${図種} で自分を親にしています: ${f.to}`, f.pos?.line ?? 0);
-      continue;
-    }
-    const 既存 = 親.get(子);
-    if (既存 !== undefined && 既存 !== 親名) {
-      伝える(
-        f.to,
-        `type: ${図種} で ${f.to} に親が 2 つあります (後の ${f.from} は使いません)`,
-        f.pos?.line ?? 0,
-      );
-      continue;
-    }
-    親.set(子, 親名);
-  }
-  // 親を辿って自分に戻る形は木にならない。 その枝を切って伝える
-  for (const 子 of [...親.keys()]) {
-    const 見た = new Set<string>([子]);
-    let p2 = 親.get(子);
-    while (p2 !== undefined) {
-      if (見た.has(p2)) {
-        伝える(子, `type: ${図種} で親を辿ると輪になります (${子} の親を外しました)`);
-        親.delete(子);
-        break;
-      }
-      見た.add(p2);
-      p2 = 親.get(p2);
-    }
-  }
-  return 親;
-}
-
-/**
- * 放射と木の箱に出す名前と補足 (#1332)。
- *
- * **連結しない**。 描画側は名前と補足を別々に受け取れば箱の中で 2 行に積む。 1 つの文字列に
- * すると 1 行に全部入り、箱幅を超えて末尾が切られる (実測 = 箱 120px に対し文字 163px)。
- *
- * `subtitle` と `value` の両方が書かれた場合は空白で繋いで 1 つの補足にする。 描画側の
- * 補足は 1 行なので、2 つを別々の行にはできない。
- */
-export function 放射に出す文字(a: DslActor): { title: string; subtitle?: string } {
-  const 続き = [a.subtitle, a.value].map((x) => x?.trim()).filter((x): x is string => !!x);
-  return { title: 箱の題(a), ...(続き.length > 0 ? { subtitle: 続き.join(" ") } : {}) };
-}

package/src/compile/journey.ts

@@ -1,93 +0,0 @@
-import { diagram } from "@cardenelabs/cdl";
-import type { CdlDiagram } from "@cardenelabs/cdl";
-import type { DslActor, DslDocument } from "../types";
-import { 図表の大きさ, 図表の大きさを読む, 語の欄から参照できる名前 } from "./chart-fields";
-import { 箱の題 } from "./node-title";
-import type { CompileNotice } from "./notice";
-import { slugify } from "./slug";
-import { 図の小見出し } from "./subtitle";
-import { 気持ち } from "./word-state";
-/**
- * ユーザージャーニー (`type: journey`) の組み立て (#1154)。 描画側に 1 つの箱で渡す。
- *
- * 登場人物ごとに **気持ち** を読む (`- 登録: "不満"`)。 使える語は `気持ち` が持つ。
- */
-export function compileJourney(
-  doc: DslDocument,
-  onNotice?: (n: CompileNotice) => void,
-): CdlDiagram {
-  const b = diagram(slugify(doc.title), { topic: doc.title, type: "journey" });
-  const { w: W, h: H } = 図表の大きさを読む(doc, 図表の大きさ.journey);
-  b.lane("chart", { width: W + 64 });
-  const data: NonNullable<CdlDiagram["nodes"][number]["journeyData"]> = [];
-  const 読めない: string[] = [];
-  const 参照できる = 語の欄から参照できる名前(doc, 気持ち);
-  for (const a of doc.actors) {
-    const 語 = (a.value ?? a.subtitle ?? "").trim();
-    // 状態を読む欄はそのまま渡す。 指す先の語は `語の状態を図の語へ直す` が図の語に直す
-    const 参照 = 語.match(/^\{(\w+)\}$/);
-    if (参照) {
-      if (!参照できる.has(参照[1]!)) {
-        読めない.push(a.name);
-        continue;
-      }
-      data.push({ id: slugify(a.name), title: 箱の題(a), emotion: 語, ...道筋の欄(a) });
-      continue;
-    }
-    const e = 気持ち.get(語);
-    if (e === undefined) {
-      読めない.push(a.name);
-      continue;
-    }
-    data.push({ id: slugify(a.name), title: 箱の題(a), emotion: e, ...道筋の欄(a) });
-  }
-  if (読めない.length > 0) {
-    const m = `type: journey で気持ちを読めない項目があります (道筋に載せません): ${読めない.join(", ")}。 \`- 登録: "不満"\` の形で、 ${[...気持ち.keys()].join(" / ")} のどれかを書いてください`;
-    onNotice?.({ kind: "chart-value-unreadable", actor: 読めない[0]!, line: 0, message: m });
-    if (typeof console !== "undefined" && console.warn) console.warn(`[dragon] ${m}`);
-  }
-  // 矢印は描けない。 書かれていたら伝える (黙って捨てると「書いたのに効かない」 が残る)
-  if (doc.flow.length > 0) {
-    const m2 = `type: journey では矢印を描けません (${doc.flow.length} 本を無視しました)。 関係を描くなら type: flow を使ってください`;
-    onNotice?.({
-      kind: "chart-edge-dropped",
-      actor: doc.flow[0]?.from ?? "",
-      line: doc.flow[0]?.pos?.line ?? 0,
-      message: m2,
-    });
-    if (typeof console !== "undefined" && console.warn) console.warn(`[dragon] ${m2}`);
-  }
-  b.node(`${slugify(doc.title) || "journey"}-chart`, {
-    lane: "chart",
-    stack: 0,
-    kind: "journey-map",
-    title: doc.title,
-    ...図の小見出し(doc),
-    w: W,
-    h: H,
-    journeyData: data,
-    ...(doc.journeyForm !== undefined ? { journeyForm: doc.journeyForm } : {}),
-    ...(doc.journeyLineForm !== undefined ? { journeyLineForm: doc.journeyLineForm } : {}),
-    ...(doc.journeyLabels !== undefined ? { journeyLabels: doc.journeyLabels } : {}),
-    ...(doc.journeySize !== undefined ? { journeySize: doc.journeySize } : {}),
-  });
-  return b.build();
-}
-
-/**
- * ユーザージャーニーの段に添える欄 (#1251)。
- *
- * 書かなければ項目ごと落とす = `undefined` を明示して渡すと、 組立て側が「空を書いた」 と
- * 区別できなくなる (`図の小見出し` と同じ理由)。
- */
-function 道筋の欄(a: DslActor): {
-  touchpoint?: string;
-  opportunity?: string;
-  opportunityPosition?: DslActor["opportunityPosition"];
-} {
-  return {
-    ...(a.touchpoint !== undefined ? { touchpoint: a.touchpoint } : {}),
-    ...(a.opportunity !== undefined ? { opportunity: a.opportunity } : {}),
-    ...(a.opportunityPosition !== undefined ? { opportunityPosition: a.opportunityPosition } : {}),
-  };
-}

package/src/compile/kinds.ts

@@ -1,139 +0,0 @@
-import type { NodeKind } from "@cardenelabs/cdl";
-
-import { DSL_ONLY_KINDS } from "../v05/parser";
-import type { PresetType } from "../types";
-/**
- * 記法に書く種類を描画側の種類へ読み替える (#2030 で `compile.ts` から移した)。
- *
- * 記法は描画側に無い種類 (`entity` / `state` 等) を受け付けるため、渡す前に読み替える。
- * 読み替えずに渡すと描画側が大きさを引けず、図の組み立てが落ちる。
- */
-
-/**
- * 記法だけが持つ種類を、描画できる種類へ読み替える (#1420)。
- *
- * 記法は `entity` / `state` のような **描画側に無い種類** を受け付ける
- * (`v05/parser.ts` の `DSL_ONLY_KINDS`)。 図種ごとの役割分け (ER 図の実体など) に使うためで、
- * 記法としては正しい。
- *
- * **そのまま描画側へ渡すと図の組み立てが落ちる**。 描画側は知らない種類の大きさを引けず、
- * `Cannot read properties of undefined (reading 'h')` で止まる (実測)。
- *
- * `er` は組み立ての中で別の種類に置き換えていたが、`flow` / `swimlane` / `state` /
- * `topology` は `a.kind` をそのまま渡していた。 記法が受ける値で図が出ない状態だったので、
- * 渡す手前で必ず通す。
- *
- * ## 読み替え先
- *
- * | 種類 | 読み替え先 | なぜ |
- * |---|---|---|
- * | `entity` | `storage` | 表を持つ = ER 図の実体 |
- * | `state` | `card` | 状態は札で表す |
- * | `loop` | `card` | 繰り返しは札で表す。 分かれ道の図では形に読み替わるのでここを通らない (#2523) |
- *
- * **表は `DSL_ONLY_KINDS` を鍵にして書く**。 種類を足した時に読み替え先が無いと
- * 型検査が落ちるので、足し忘れが残らない。
- */
-export const 記法だけの種類の読み替え: Readonly<Record<(typeof DSL_ONLY_KINDS)[number], NodeKind>> =
-  {
-    entity: "storage",
-    state: "card",
-    loop: "card",
-  };
-
-/** 描画側へ渡せる種類にする。 記法だけの種類はここで読み替わる (#1420) */
-export function 描ける種別(kind: string | undefined): NodeKind {
-  if (kind === undefined) return "actor";
-  const 読み替え先 = (記法だけの種類の読み替え as Record<string, NodeKind | undefined>)[kind];
-  return 読み替え先 ?? (kind as NodeKind);
-}
-
-/**
- * 図種ごとの図の作り (#1219 / #1220)。
- *
- * 2 つの判断がここから決まる。 解決できない矢印を中央で落とすか (#1219) と、 名前が同じ id に
- * 潰れる登場人物を作り替えるか (#1220)。 どちらも **登場人物の名前が箱や枠の id になる図種**
- * でだけ要る。
- *
- * `#1209` は動きを書いた 2 経路だけを塞いだ。 残る経路では **知らせは出るのに図まで壊れる**
- * 状態だった (実測 = 8 図種が `compile` の `unknown-ref` で落ちる)。
- *
- * | 作り | 解決できない矢印 | 同じ id に潰れる名前 |
- * |---|---|---|
- * | 登場人物ごとに箱 | 中央で落とす | 名前を作り替えて id を分ける |
- * | 図全体を 1 箱 | 図種に任せる | 触らない |
- *
- * **1 箱で描く図種を中央で落とさない**。 これらは矢印そのものを描かず、 書かれた本数を数えて
- * 独自の知らせを出す (`chart-edge-dropped` / 木の親子の知らせ)。 中央で外すと本数が変わり、
- * 全部が解決できない図では知らせごと消える。 同じ id に潰れる名前も、 中身を payload が
- * 持つため箱の id にならず、 木と放射は独自の知らせを出す。
- *
- * `Record<PresetType, ...>` にしてあるので、 図種を足した時にどちらかを決めないと型検査が
- * 落ちる (`rules/quality.md § 多層 SSOT 経路の全 registration 保証` と同じ形)。
- */
-export const 図種の作り: Record<PresetType, "登場人物ごとに箱" | "図全体を 1 箱"> = {
-  // 矢印の端と登場人物の名前が、 そのまま箱や枠の id になる
-  sequence: "登場人物ごとに箱",
-  flow: "登場人物ごとに箱",
-  flowchart: "登場人物ごとに箱",
-  swimlane: "登場人物ごとに箱",
-  record: "登場人物ごとに箱",
-  topology: "登場人物ごとに箱",
-  c4: "登場人物ごとに箱",
-  // 中身は payload が持ち、 図そのものは 1 箱。 矢印は描かず本数を数えて知らせる
-  gantt: "図全体を 1 箱",
-  chart: "図全体を 1 箱",
-  funnel: "図全体を 1 箱",
-  tree: "図全体を 1 箱",
-  journey: "図全体を 1 箱",
-  quadrant: "図全体を 1 箱",
-  mind: "図全体を 1 箱",
-};
-
-/**
- * 図全体を 1 つの箱で描く種別。
- *
- * これらは中身 (扇 / 帯 / 枝) を payload で受け取り、 1 node で図全体を描く。 登場人物ごとの箱を
- * 持たないので、 段の `focus:` で名前を指しても引く先が無い。 `injectPhasesFallback` が
- * この一覧を使って「実在する名前ならその箱を光らせる」 に読み替える (#1076 / #1077)。
- *
- * `mind-map` は一時期 **記法から到達しなかった** (`#1174`)。 この種別を作っていたのは
- * `compileRadial` だけで `#1170` で消え、 記法の `type: mind` は `card` を 3 列に並べる
- * 別実装だった。
- *
- * それでも一覧に残すのは、 ここが「1 箱で図全体を描く種別」 という **性質の一覧** だから。
- * `mind-map` は engine 側でその性質を持ち続けており、 記法が到達しないのは当時の
- * `compileMind` の実装によるものだった。 `#1177` で `compileMind` を `mind-map` に寄せたため、
- * **今は記法からも到達する** (一覧へ戻す作業が要らなかったのはこのため)。
- *
- * ## 図表の種別は 1 つ残らず載せる (#1668)
- *
- * 弧と帯で量を表す 3 種 (`chart-gauge` / `chart-radial` / `chart-stacked-bar`) と、
- * 値 1 つを大きく示す 2 種 (`chart-stat` / `chart-waffle`) が抜けていた。 5 種とも中身を
- * payload で受け取って 1 箱で描く = この一覧が言う性質をそのまま持つ。
- *
- * 抜けている間、段の `draw:` を書いても指す先が引けず **書けるのに動かない** 状態になる
- * (`draw` の解決は「1 箱で描く箱がちょうど 1 つ」 を条件にしている)。 `focus:` で登場人物の
- * 名前を書いた時に何も光らないのも同じ穴で、載せると図の箱が光るようになる。
- */
-export const SINGLE_BOX_KINDS: ReadonlySet<string> = new Set([
-  "chart-pie",
-  "chart-line",
-  "chart-bar",
-  "gantt-timeline",
-  "mind-map",
-  "funnel-stages",
-  "quadrant-matrix",
-  "tree-hierarchy",
-  "journey-map",
-  // 2 時点を直線でつなぐ図も 1 箱で全体を描く (#1647)
-  "chart-slope",
-  // 弧と帯で量を表す 3 種も 1 箱で全体を描く (#1668)
-  "chart-gauge",
-  "chart-radial",
-  "chart-stacked-bar",
-  // 値 1 つを大きく示す図と、1 個 = 1% の印を埋める図も同じ (#1668)。
-  // 段の `draw:` は受けない (描画側が起点から描く動きを持たない) が、性質は同じなので載せる
-  "chart-stat",
-  "chart-waffle",
-]);

package/src/compile/lanes.ts

@@ -1,138 +0,0 @@
-import type { DslDocument, PresetType } from "../types";
-/**
- * 箱に書いた縦列の扱い (#2030 で `compile.ts` から移した)。
- *
- * 縦列を書ける図種と、書いた縦列をそのまま使うかの判定。
- *
- * **葉に置く** = 図種ごとの file と、`compile.ts` に残る「書いたのに効かない」 の知らせの
- * 両方が呼ぶ。
- */
-
-/**
- * 縦列を選べる図種 (#1263)。
- *
- * 縦列を **箱を並べるための入れ物** として使う図種だけを許す。 順序図は
- * 縦列がそのまま生命線として描かれる骨格なので許さない (#1248 の判断はこちらに当たる)。
- *
- * `er` は「1 縦列 1 箱」 が図の読み方そのもの (表が横に並ぶ) なので、2 つの箱を同じ縦列へ
- * 入れられる形にはしない。
- *
- * 状態遷移図は外した (#1466)。設計が格子に置く形になり、
- * 「箱の 1 つの辺には関係を 1 本まで」 を守るには 1 つの縦列に複数の箱が要る。
- * 「1 縦列 1 箱」 が読み方だった前提はここで崩れている。
- */
-export const 縦列を選べる図種: ReadonlySet<PresetType> = new Set<PresetType>([
-  "flow",
-  "topology",
-  "swimlane",
-  /*
-   * 分かれ道の図 (#2513)。
-   *
-   * この図種は **縦列が役割で、箱はその中に置く**。 1 人の役割の中に複数の箱が並ぶ形
-   * (申請を出す / 直して出し直す) が図の読み方そのものなので、書いた縦列をそのまま使う。
-   */
-  "flowchart",
-  /*
-   * 行を持つ図 (#1571 / #2782)。
-   *
-   * 畳む前の表の図は、組み立て器が実体 1 つにつき帯を 1 本作り必ず段 0 に置いていた =
-   * 表が横 1 列にしか並ばない。 関係を 4 本持つ実体があると、どう並べ替えても 2 本は隣を
-   * 飛び越す (意匠帳 `docs/design/er/note.md` § 記法の制約 が 4 通りを実測しており、
-   * 1 列は縦横比 7.0 / 最長の線 4068、格子は 3.5 / 836)。
-   */
-  "record",
-]);
-
-/**
- * 書いた縦列に箱を置く形か (#1263)。
- *
- * **全ての箱が縦列を書いた時だけ** この形にする。 一部だけ書いた形は、書かなかった箱の
- * 行き先を決める規則が要る (既定の縦列に集める / 自分の縦列を作る) が、どちらも
- * 書いた人の意図と一致する保証が無い。 混ざった形は `reportLaneMixed` が知らせる。
- *
- * 数える箱は `縦列の判定に数える箱` が決める (#2372)。
- */
-export function 書いた縦列に置く(kind: PresetType, doc: DslDocument): boolean {
-  if (!縦列を選べる図種.has(kind)) return false;
-  const 対象 = 縦列の判定に数える箱(doc);
-  return 対象.length > 0 && 対象.every((a) => a.lane !== undefined);
-}
-
-/**
- * 縦列の判定で数える箱 (#2372)。
- *
- * **見本 (`parts`) は縦列を書いた時だけ数える**。 見本の縦列は張替え先の指定で、
- * 箱を並べる話ではない = 書いていない見本を数に入れると、普通の箱が全部書いた図まで
- * 「一部だけ書いた」 に倒れる。
- *
- * 逆に見本を **常に** 外すと、箱が全部見本の図で対象が 0 件になり
- * 「全ての箱が縦列を書いた」 が成立しない。 結果は 3 つ重なる =
- * 書いた縦列に箱が入らない / 宣言した縦列が空のまま残る / 誤って「どの箱も入らない」 と知らせる
- * (実測 = カタログの見本 19 枚で知らせが 38 件)。
- *
- * 見本が混ざった図では普通の箱が対象になって成立し、**見本も一緒に書いた縦列へ入っていた**
- * = 見本を縦列へ入れられないわけではなく、数え方だけが割れていた。
- *
- * **置く側と知らせる側で同じ数え方を使う**。 別々に数えると、見本だけの図で
- * 「一部だけ書いた」 形が知らせずに落ちる。
- */
-export function 縦列の判定に数える箱(doc: DslDocument): DslDocument["actors"] {
-  const 見本が縦列を書いた = doc.actors.some((a) => a.partId !== undefined && a.lane !== undefined);
-  return 見本が縦列を書いた ? doc.actors : doc.actors.filter((a) => a.partId === undefined);
-}
-
-/**
- * 縦列ごとに箱の段を決める (#1394 / #2396)。
- *
- * 段は **書いた番号をそのまま持つ**。 書き順で 0 から詰め直すと、`stack: 1` と書いた箱が
- * 0 へ落ちる = 決定木のように「同じ高さに並ばない」 ことが図の意味そのものになる形では、
- * 詰めた瞬間に別の図になる (実測 = 3 段の木の根が 1 段目へ上がった)。
- *
- * 書かなかった箱は、その縦列で **空いている一番小さい段** に置く。 単に数え上げると
- * 書いた番号と重なり、2 つの箱が同じ段に載る。
- *
- * **箱を並べる図種すべてが同じ決め方を使う** (#2396)。かつてのクラス図だけこの決め方を持たず、
- * 段を書かない箱を全て 0 に残していた。 同じ縦列に箱を 2 つ置くと配置の計算が
- * 「同じ場所に 2 つある」 として投げ、図が 1 枚も描けない (実測 = 24 図種で落ちるのは
- * class 専用経路だけ)。
- *
- * @param actors 記法から読んだ箱を書いた順に並べたもの
- * @param 縦列を引く 箱を同じ段の集合へ分ける鍵。 省略時は `lane` を使う
- * @returns 段を持つ箱だけの表。 縦列も段も書かない箱は入らない (呼出側が既定に任せる)
- */
-export function 縦列ごとの段を決める(
-  actors: DslDocument["actors"],
-  縦列を引く: (actor: DslDocument["actors"][number]) => string | undefined = (actor) =>
-    actor.lane,
-): ReadonlyMap<DslDocument["actors"][number], number> {
-  const 埋まった段 = new Map<string, Set<number>>();
-  const 埋める = (lid: string, stack: number): void => {
-    const 集合 = 埋まった段.get(lid) ?? new Set<number>();
-    集合.add(stack);
-    埋まった段.set(lid, 集合);
-  };
-  // 書いた番号を先に全て埋める = 書き順が後の箱の番号とも重ならない
-  for (const a of actors) {
-    const 縦列 = 縦列を引く(a);
-    if (縦列 !== undefined && a.stack !== undefined) 埋める(縦列, a.stack);
-  }
-  const 決めた = new Map<DslDocument["actors"][number], number>();
-  for (const a of actors) {
-    const 縦列 = 縦列を引く(a);
-    if (縦列 === undefined) {
-      // 縦列を書かない箱は縦列の中の段を持たない。 段だけ書いた箱はその番号を渡す
-      if (a.stack !== undefined) 決めた.set(a, a.stack);
-      continue;
-    }
-    if (a.stack !== undefined) {
-      決めた.set(a, a.stack);
-      continue;
-    }
-    let stack = 0;
-    const 集合 = 埋まった段.get(縦列);
-    while (集合?.has(stack)) stack += 1;
-    埋める(縦列, stack);
-    決めた.set(a, stack);
-  }
-  return 決めた;
-}