@cardenelabs/dragon 0.18.3 → 0.20.0

package/src/types.ts

@@ -5,7 +5,7 @@
 
 import type { CdlDiagram, NodeKind, Tone, EdgeStyle, EdgeHead, EdgeHeadFill, EdgeReveal, ClassRelationType, SequenceMessageKind } from "@cardenelabs/cdl";
 import type { DslOnlyKind } from "./v05/parser";
-import type { DslDirection } from "./keywords";
+import type { DslDirection, DslPalette } from "./keywords";
 
 /**
  * 記法が書ける箱の種類 (#1420)。
@@ -178,6 +178,16 @@ export type DslDocument = {
   direction?: DslDirection;
   /** `direction:` を書いた行。 効かない時の知らせで、書いた場所を指すために持つ */
   directionPos?: { line: number };
+  /**
+   * 図の配色 (`palette:`、 #1553)。
+   *
+   * 名前だけを持つ。 実際の色は消費側 (`cdl-theme.css`) が決めるので、ここには値を書かない。
+   * ER 図とクラス図は書かなくても `kinari` (生成りに茶) になる。 どちらも箱の作りが同じ
+   * (行頭の印 + 左に名前 + 右に型) で、名前と型が離れて並ぶため、行を横に追う目印
+   * (行の縞) が要る。 縞の色は配色からしか来ないので、既定が無いと縞が箱の面と同じ色に
+   * 落ちて 1 本も出ない。 書き手が `palette:` を書いた時はそちらが勝つ。
+   */
+  palette?: DslPalette;
   groups?: Record<string, DslGroup>;
   /**
    * 値を見せる部品 (`readouts:`、 #1374)。 割合の輪や数え上げを図の脇に出す。
@@ -480,6 +490,10 @@ export type DslStep = {
    * `kind` にしないのは、箱の種類 (`DslActor.kind`) と同じ語が別の意味を持つため。
    */
   msgKind?: SequenceMessageKind;
+  /** 辺の役目 (cdl#618)。 `main` を書いた辺だけ「いま」 の色で引く */
+  role?: "main";
+  /** 名前の下地を敷くか (cdl#618)。 書かなければ敷く */
+  labelPlate?: boolean;
   labelOffsetX?: number;
   labelOffsetY?: number;
   /** true で説明文を矢印の線の上に重ねる。 分岐図の条件ラベル用。 */

package/src/v05/parser.ts

@@ -44,7 +44,8 @@
 import type { NodeKind, Tone, EdgeStyle, EdgeHead, EdgeHeadFill, ClassRelationType, SequenceMessageKind } from "@cardenelabs/cdl";
 import { TONES, NODE_KINDS, EDGE_HEADS, EDGE_HEAD_FILLS, EDGE_STYLES, EDGE_REVEALS, CLASS_RELATION_LOOK, SEQUENCE_MESSAGE_LOOK, parseFormula } from "@cardenelabs/cdl";
 import type { EdgeReveal } from "@cardenelabs/cdl";
-import { TONE_ALIAS, NODE_KIND_ALIAS, DIRECTIONS, resolveDirection } from "../keywords";
+import { TONE_ALIAS, NODE_KIND_ALIAS, DIRECTIONS, resolveDirection, PALETTES, resolvePalette } from "../keywords";
+import type { DslPalette } from "../keywords";
 import type { DslDirection } from "../keywords";
 import { parseRelativePos, orderByDependency } from "../relative-pos";
 import {
@@ -96,6 +97,22 @@ export const EDGE_HEAD_VALUES: readonly string[] = EDGE_HEADS;
 /** 端の印の塗り方 (#1466)。 描画側の一覧から導く = 描画側が増やせば書ける */
 export const EDGE_HEAD_FILL_VALUES: readonly string[] = EDGE_HEAD_FILLS;
 
+/**
+ * 辺の役目として書ける語 (#1559)。
+ *
+ * 読み手と公開 schema の両方がここを見る。 語を 2 か所に書くと、記法では通るのに JSON では
+ * 弾かれる (逆も) 形が黙って生まれる。
+ */
+export const EDGE_ROLE_VALUES = ["main"] as const;
+
+/**
+ * 図形の向きとして書ける語 (#1561)。
+ *
+ * 読み手と、読めなかった時の案内と、公開 schema の 3 か所がここを見る。 値を直に書くと、
+ * 語を足した時にどれかが取り残される (実測 = 読み手と案内で同じ 4 語を 2 度書いていた)。
+ */
+export const SHAPE_ORIENT_VALUES = ["up", "down", "left", "right"] as const;
+
 /**
  * クラス図の関係の種類 (#1466)。 描画側の表 (`CLASS_RELATION_LOOK`) の key から導く。
  *
@@ -153,6 +170,18 @@ export const TOP_LEVEL_KEYS = [
    * 日本語で書けるので、書き手が自然に言う語 (`縦` / `横`) を残せる。
    */
   "direction",
+  /*
+   * 図の配色 (#1553)。
+   *
+   * cdl は色を持たないので、名前だけを図に載せる。 消費側 (`cdl-theme.css`) が名前を見て
+   * 7 つの口 (台 / 行の面 / 縞 / 枠 / 字 / 型名 / 線) に色を当てる。
+   *
+   * ER 図とクラス図は書かなくても `kinari` (生成りに茶) になる。 どちらも箱の作りが同じ
+   * (行頭の印 + 左に名前 + 右に型) で、名前と型が離れて並ぶため、行を横に追う目印
+   * (行の縞) が要る。 縞の色は配色からしか来ないので、既定が無いと縞が箱の面と同じ色に
+   * 落ちて 1 本も出ない。 書き手が `palette:` を書いた時はそちらが勝つ。
+   */
+  "palette",
 ] as const;
 
 /**
@@ -440,6 +469,7 @@ export function parseTextDslV05(src: string): V05ParseResult {
   let reveal: EdgeReveal | null = null;
   let direction: DslDirection | null = null;
   let directionLine = 0;
+  let palette: DslPalette | null = null;
   let axes: DslAxes | undefined = undefined;
   let axesLine = 0;
   let actors: DslActor[] = [];
@@ -532,6 +562,29 @@ export function parseTextDslV05(src: string): V05ParseResult {
       i += 1;
       continue;
     }
+    if (head.key === "palette") {
+      /*
+       * 図の配色 (#1553)。
+       *
+       * 読めない語はその場で知らせる。 黙って既定に落とすと、書き手には「書いたのに効かない」
+       * としか見えず、書き間違いか未対応かを分けられない。
+       */
+      const v = (head.value ?? "").trim();
+      if (v.length > 0) {
+        const 解けた = resolvePalette(v);
+        if (解けた !== null) {
+          palette = 解けた;
+        } else {
+          errors.push({
+            line: line.no,
+            message: `palette が読めません (書いた値: ${v})`,
+            hint: `使える語 = ${PALETTES.join(" / ")} / 生成り / 青磁`,
+          });
+        }
+      }
+      i += 1;
+      continue;
+    }
     if (head.key === "eyebrow") {
       // 空で書いた形 (`eyebrow:`) は「書かなかった」 と同じにする。 空文字を残すと
       // 描画側が中身のない帯を出す
@@ -1007,6 +1060,7 @@ export function parseTextDslV05(src: string): V05ParseResult {
       ...(eyebrow !== null ? { eyebrow, eyebrowPos: { line: eyebrowLine } } : {}),
       ...(reveal !== null ? { reveal } : {}),
       ...(direction !== null ? { direction, directionPos: { line: directionLine } } : {}),
+      ...(palette !== null ? { palette } : {}),
       ...(axes !== undefined ? { axes, axesPos: { line: axesLine } } : {}),
       actors,
       flow,
@@ -1655,12 +1709,12 @@ function 表に従って読む(
         });
       }
     } else if (形 === "向き") {
-      if (["up", "down", "left", "right"].includes(値)) out[欄] = 値;
+      if ((SHAPE_ORIENT_VALUES as readonly string[]).includes(値)) out[欄] = 値;
       else {
         errors.push({
           line,
           message: `${接頭}${欄} の向きが読めません: "${値}"`,
-          hint: "使える値 = up, down, left, right",
+          hint: `使える値 = ${SHAPE_ORIENT_VALUES.join(", ")}`,
         });
       }
     } else {
@@ -3129,6 +3183,23 @@ const FLOW_INLINE_READERS = {
   sub: (v: string | undefined) => v,
   guard: (v: string | undefined) => v,
   cardinality: (v: string | undefined) => v,
+  /*
+   * 辺の役目 (cdl#618)。 `main` を書いた辺だけ「いま」 の色で引く。
+   *
+   * 図の中に道が 2 種 (主となる 1 本と、そこから枝分かれする先) ある時、どちらも同じ色だと
+   * どこから読むかが決まらない。 主となる 1 本 (または 1 続き) にだけ書く。
+   */
+  role: (v: string | undefined) =>
+    v !== undefined && (EDGE_ROLE_VALUES as readonly string[]).includes(v)
+      ? (v as "main")
+      : undefined,
+  /*
+   * 名前の下地を敷くか (cdl#618)。 書かなければ敷く。
+   *
+   * 丸い下地は箱と同じ形なので、罫の細い図では名前が小さな箱に見える。
+   */
+  labelPlate: (v: string | undefined) =>
+    v === undefined ? undefined : v !== "false" && v !== "なし",
   // 矢印がどの辺から出るか (#1385)。 描画側は 4 方向を取り、書かなければ自動で選ぶ
   side: (v: string | undefined) =>
     v !== undefined && (EDGE_SIDE_VALUES as readonly string[]).includes(v)
@@ -3448,6 +3519,9 @@ function parseFlowStep(line: Line, no: number, errors: DslError[]): DslStep | nu
   const tailHeadFill = 中括弧.tailHeadFill as EdgeHeadFill | undefined;
   const relation = 中括弧.relation as ClassRelationType | undefined;
   const msgKind = 中括弧.kind as SequenceMessageKind | undefined;
+  // 辺の役目と名前の下地 (cdl#618)
+  const role = 中括弧.role as "main" | undefined;
+  const labelPlate = 中括弧.labelPlate as boolean | undefined;
   // 値に追随する 3 欄 (#1396)。 空は捨てずに知らせる = 描画側は空文字を既定値へ落とさず
   // そのまま置換に使うため、書き忘れが「線が消えた」 形で出る
   const widthBind = 追随する大きさとして読む(
@@ -3534,6 +3608,8 @@ function parseFlowStep(line: Line, no: number, errors: DslError[]): DslStep | nu
     tailHeadFill,
     relation,
     msgKind,
+    role,
+    labelPlate,
     widthBind,
     strokeBind,
     dashOffsetBind,