@riebeckite/plugin-excalibrain 0.0.3 → 0.0.6

package/README.md

@@ -1,165 +1,172 @@
-# @riebeckite/plugin-excalibrain
-
-Structured relationship maps for notes, modelled on
-[ExcaliBrain](https://github.com/zsviczian/excalibrain) by Zsolt Viczián.
-
-[日本語](./README_ja.md)
-
-## Overview
-
-`excaliBrain()` renders each note in a planar layout with seven regions:
-
-| Region | Direction | Role |
-| ------ | --------- | ---- |
-| Parents | top | `parent` |
-| Children | bottom | `child` |
-| Left friends | left | `leftFriend` |
-| Right friends | right | `rightFriend` |
-| Previous | far left | `previous` |
-| Next | far right | `next` |
-| Siblings | periphery | `sibling` |
-
-Relationships come from ExcaliBrain's ontology: YAML frontmatter fields and
-dataview inline fields in the note body. When a relationship is not stated
-explicitly, it is inferred from the content graph.
-
-## Usage
-
-```ts
-import { defineConfig } from "@riebeckite/core";
-import { excaliBrain } from "@riebeckite/plugin-excalibrain";
-
-export default defineConfig({
-  // ...
-  plugins: [
-    excaliBrain({
-      render: "build",
-    }),
-  ],
-});
-```
-
-The plugin runs with `order: -10`.
-
-## Declaring relationships
-
-Explicit relations win over inferred ones.
-
-### YAML frontmatter
-
-```md
----
-title: ExcaliBrain Center
-parent: "[[excalibrain-parent]]"
-children: ["[[excalibrain-child-a]]", "[[excalibrain-child-b]]"]
----
-```
-
-### Dataview inline fields
-
-```md
-children:: [[excalibrain-child]]
-
-related:: [[note-a]] and [[note-b]] are similar
-```
-
-An inline field may appear on its own line or inside brackets
-(`[field:: [[target]]]`).
-
-### Ontology
-
-Field names are matched case-insensitively and spaces are normalized to
-hyphens. The default ontology is:
-
-| Role | Field names |
-| ---- | ----------- |
-| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception` |
-| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to` |
-| `leftFriends` | `friends`, `friend`, `similar`, `supports`, `alternatives`, `advantages` |
-| `rightFriends` | `opposes`, `disadvantages`, `missing`, `cons` |
-| `previous` | `previous`, `prev`, `west`, `w`, `before` |
-| `next` | `next`, `n`, `east`, `e`, `after` |
-| `hidden` | `hidden` |
-
-## Inference
-
-When `infer` is enabled (the default):
-
-- a forward link (this note → other) becomes a `child`;
-- a backlink (other → this note) becomes a `parent`;
-- a mutual link (this note ↔ other) becomes a `leftFriend`.
-
-With `siblings` enabled (the default), the other children of this note's
-parents become `sibling` nodes. Link targets are resolved against the content
-manifest; unresolved targets become virtual nodes labelled with the raw link
-text (`data-node-virtual="true"`).
-
-## Rendering
-
-The `render` option selects where the map is produced:
-
-| Mode | Behavior |
-| ---- | -------- |
-| `"build"` (default) | The SVG is generated at build time and inlined into the article. |
-| `"client"` | A `div.rb-excalibrain__canvas` carries the escaped graph/layout payload; `initExcaliBrain()` builds the SVG in the browser. |
-| `"both"` | Inline SVG plus the client layer for progressive enhancement. |
-
-### Injection
-
-- A ` ```excalibrain ` fence is replaced by the map.
-- Otherwise, when `auto` is enabled and the note has at least one
-  relationship, the map section is appended to the article HTML (both the
-  manifest entry and the cached post content).
-
-`heading` / `headingText` control the optional `<h2>`.
-
-## Options
-
-| Option | Type | Default | Description |
-| ------ | ---- | ------- | ----------- |
-| `render` | `"build" \| "client" \| "both"` | `"build"` | Where the map is rendered |
-| `auto` | `boolean` | `true` | Append the map when a note has no fence |
-| `heading` | `boolean` | `true` | Show the heading |
-| `headingText` | `string` | `"ExcaliBrain"` | Heading text |
-| `className` | `string` | `"rb-excalibrain"` | Root CSS class |
-| `maxPerRegion` | `number` | `8` | Maximum nodes per region |
-| `infer` | `boolean` | `true` | Infer relations from links |
-| `siblings` | `boolean` | `true` | Infer siblings from parents |
-| `ontology` | object | — | Partial ontology field overrides |
-| `showHidden` | `boolean` | `false` | Include notes marked hidden |
-| `width` | `number` | `720` | SVG viewBox width |
-| `height` | `number` | `480` | SVG viewBox height |
-| `language` | `string` | `"excalibrain"` | Fence language |
-
-## Output
-
-```html
-<section class="rb-excalibrain" data-excalibrain
-         data-excalibrain-render="build"
-         data-excalibrain-center="notes/center">
-  <h2 class="rb-excalibrain__heading">ExcaliBrain</h2>
-  <div class="rb-excalibrain__canvas">
-    <svg class="rb-excalibrain__svg" viewBox="0 0 720 480" role="img">…</svg>
-  </div>
-</section>
-```
-
-Each region is a `g.rb-excalibrain__region[data-region]`; each node is a
-`g.rb-excalibrain__node[data-node-role][data-node-slug][data-relation-type]`
-wrapping an `<a href>` around its `<rect>` and `<text>`. Links are
-`path.rb-excalibrain__link[data-link-role][data-relation-type]`.
-
-## Exports
-
-- `excaliBrain(options?)` / `excaliBrainPlugin` — plugin factory
-- `resolveExcaliBrainOptions(options?)` — resolved defaults
-- `buildExcaliBrainGraph(input)` — pure graph builder
-- `layoutExcaliBrain(graph, options?)` — pure deterministic layout
-- `renderExcaliBrainSvg(graph, layout, options?)` — pure SVG renderer
-- Types: `ExcaliBrainOptions`, `ExcaliBrainGraph`, `ExcaliBrainNode`,
-  `ExcaliBrainLink`, `ExcaliBrainLayout`, `ExcaliBrainRole`,
-  `ExcaliBrainRenderMode`, …
-
-## See also
-
-- [Plugin guide](../../../docs/en/plugin-system.md)
+# @riebeckite/plugin-excalibrain
+
+Structured relationship maps for notes, modelled on
+[ExcaliBrain](https://github.com/zsviczian/excalibrain) by Zsolt Viczián.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`excaliBrain()` renders each note in a planar layout with seven regions:
+
+| Region | Direction | Role |
+| ------ | --------- | ---- |
+| Parents | top | `parent` |
+| Children | bottom | `child` |
+| Left friends | left | `leftFriend` |
+| Right friends | right | `rightFriend` |
+| Previous | far left | `previous` |
+| Next | far right | `next` |
+| Siblings | periphery | `sibling` |
+
+Relationships come from ExcaliBrain's ontology: YAML frontmatter fields and
+dataview inline fields in the note body. When a relationship is not stated
+explicitly, it is inferred from the content graph.
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { excaliBrain } from "@riebeckite/plugin-excalibrain";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    excaliBrain({
+      render: "build",
+    }),
+  ],
+});
+```
+
+The plugin runs with `order: -10`.
+
+## Declaring relationships
+
+Explicit relations win over inferred ones.
+
+### YAML frontmatter
+
+```md
+---
+title: ExcaliBrain Center
+parent: "[[excalibrain-parent]]"
+children: ["[[excalibrain-child-a]]", "[[excalibrain-child-b]]"]
+---
+```
+
+### Dataview inline fields
+
+```md
+children:: [[excalibrain-child]]
+
+related:: [[note-a]] and [[note-b]] are similar
+```
+
+An inline field may appear on its own line or inside brackets
+(`[field:: [[target]]]`).
+
+### Ontology
+
+Field names are matched case-insensitively and spaces are normalized to
+hyphens. The default ontology is:
+
+| Role | Field names |
+| ---- | ----------- |
+| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception` |
+| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to` |
+| `leftFriends` | `friends`, `friend`, `similar`, `supports`, `alternatives`, `advantages` |
+| `rightFriends` | `opposes`, `disadvantages`, `missing`, `cons` |
+| `previous` | `previous`, `prev`, `west`, `w`, `before` |
+| `next` | `next`, `n`, `east`, `e`, `after` |
+| `hidden` | `hidden` |
+
+The `ontology` option extends the defaults: each role's field names are
+appended to that role's defaults rather than replacing them. An override can
+still add an existing field to another role, but earlier roles in the
+canonical order (`parents`, `children`, `leftFriends`, `rightFriends`,
+`previous`, `next`, `hidden`) win when a field is listed twice.
+
+## Inference
+
+When `infer` is enabled (the default):
+
+- a forward link (this note → other) becomes a `child`;
+- a backlink (other → this note) becomes a `parent`;
+- a mutual link (this note ↔ other) becomes a `leftFriend`.
+
+With `siblings` enabled (the default), the other children of this note's
+parents become `sibling` nodes. Sibling inference also requires `infer`:
+setting `infer: false` disables it. Link targets are resolved against the
+content manifest; unresolved targets become virtual nodes labelled with the
+raw link text (`data-node-virtual="true"`).
+
+## Rendering
+
+The `render` option selects where the map is produced:
+
+| Mode | Behavior |
+| ---- | -------- |
+| `"build"` (default) | The SVG is generated at build time and inlined into the article. |
+| `"client"` | A `div.rb-excalibrain__canvas` carries the escaped graph/layout payload; `initExcaliBrain()` builds the SVG in the browser. |
+| `"both"` | Inline SVG plus the client layer for progressive enhancement. |
+
+### Injection
+
+- A ` ```excalibrain ` fence is replaced by the map.
+- Otherwise, when `auto` is enabled and the note has at least one
+  relationship, the map section is appended to the article HTML (both the
+  manifest entry and the cached post content).
+
+`heading` / `headingText` control the optional `<h2>`.
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `render` | `"build" \| "client" \| "both"` | `"build"` | Where the map is rendered |
+| `auto` | `boolean` | `true` | Append the map when a note has no fence |
+| `heading` | `boolean` | `true` | Show the heading |
+| `headingText` | `string` | `"ExcaliBrain"` | Heading text |
+| `className` | `string` | `"rb-excalibrain"` | Root CSS class |
+| `maxPerRegion` | `number` | `8` | Maximum nodes per region |
+| `infer` | `boolean` | `true` | Infer relations from links |
+| `siblings` | `boolean` | `true` | Infer siblings from parents (requires `infer`) |
+| `ontology` | object | — | Ontology field names appended per role |
+| `showHidden` | `boolean` | `false` | Include notes marked hidden |
+| `width` | `number` | `720` | SVG viewBox width |
+| `height` | `number` | `480` | SVG viewBox height |
+| `language` | `string` | `"excalibrain"` | Fence language |
+
+## Output
+
+```html
+<section class="rb-excalibrain" data-excalibrain
+         data-excalibrain-render="build"
+         data-excalibrain-center="notes/center">
+  <h2 class="rb-excalibrain__heading">ExcaliBrain</h2>
+  <div class="rb-excalibrain__canvas">
+    <svg class="rb-excalibrain__svg" viewBox="0 0 720 480" role="img">…</svg>
+  </div>
+</section>
+```
+
+Each region is a `g.rb-excalibrain__region[data-region]`; each node is a
+`g.rb-excalibrain__node[data-node-role][data-node-slug][data-relation-type]`
+wrapping an `<a href>` around its `<rect>` and `<text>`. Links are
+`path.rb-excalibrain__link[data-link-role][data-relation-type]`.
+
+## Exports
+
+- `excaliBrain(options?)` / `excaliBrainPlugin` — plugin factory
+- `resolveExcaliBrainOptions(options?)` — resolved defaults
+- `buildExcaliBrainGraph(input)` — pure graph builder
+- `layoutExcaliBrain(graph, options?)` — pure deterministic layout
+- `renderExcaliBrainSvg(graph, layout, options?)` — pure SVG renderer
+- Types: `ExcaliBrainOptions`, `ExcaliBrainGraph`, `ExcaliBrainNode`,
+  `ExcaliBrainLink`, `ExcaliBrainLayout`, `ExcaliBrainRole`,
+  `ExcaliBrainRenderMode`, …
+
+## See also
+
+- [Plugin guide](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -1,150 +1,152 @@
-# @riebeckite/plugin-excalibrain
-
-ノートの関係を構造化して表示するプラグインです。[ExcaliBrain](https://github.com/zsviczian/excalibrain)（Zsolt Viczián）の考え方をモデルにしています。
-
-[English](./README.md)
-
-## 概要
-
-`excaliBrain()` はノートごとに 7 つの領域を持つマップを描画します。
-
-| 領域 | 位置 | ロール |
-| --- | --- | --- |
-| Parents | 上 | `parent` |
-| Children | 下 | `child` |
-| Left friends | 左 | `leftFriend` |
-| Right friends | 右 | `rightFriend` |
-| Previous | 左端 | `previous` |
-| Next | 右端 | `next` |
-| Siblings | 周辺 | `sibling` |
-
-関係は ExcaliBrain のオントロジーに従い、YAML フロントマターと本文中の Dataview インラインフィールドから取得します。明示されていない関係は、コンテンツグラフから推論します。
-
-## 設定する
-
-```ts
-import { defineConfig } from "@riebeckite/core";
-import { excaliBrain } from "@riebeckite/plugin-excalibrain";
-
-export default defineConfig({
-  // ...
-  plugins: [
-    excaliBrain({
-      render: "build",
-    }),
-  ],
-});
-```
-
-このプラグインは `order: -10` で実行されます。
-
-## 関係の書き方
-
-明示した関係は推論より優先されます。
-
-### YAML フロントマター
-
-```md
----
-title: ExcaliBrain Center
-parent: "[[excalibrain-parent]]"
-children: ["[[excalibrain-child-a]]", "[[excalibrain-child-b]]"]
----
-```
-
-### Dataview インラインフィールド
-
-```md
-children:: [[excalibrain-child]]
-
-related:: [[note-a]] and [[note-b]] are similar
-```
-
-フィールドは単独行でも、`[field:: [[target]]]` のように角括弧で囲んでも認識します。
-
-### オントロジー
-
-フィールド名は大文字小文字を区別せず、空白はハイフンに正規化して照合します。既定のオントロジーは次のとおりです。
-
-| ロール | フィールド名 |
-| --- | --- |
-| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception` |
-| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to` |
-| `leftFriends` | `friends`, `friend`, `similar`, `supports`, `alternatives`, `advantages` |
-| `rightFriends` | `opposes`, `disadvantages`, `missing`, `cons` |
-| `previous` | `previous`, `prev`, `west`, `w`, `before` |
-| `next` | `next`, `n`, `east`, `e`, `after` |
-| `hidden` | `hidden` |
-
-## 推論
-
-`infer` が有効な場合（既定）、次のように推論します。
-
-- このノートから相手へのリンクは `child`
-- 相手からこのノートへのバックリンクは `parent`
-- 相互リンクは `leftFriend`
-
-`siblings` が有効な場合（既定）、親ノートの他の子ノートを `sibling` として追加します。リンク先はコンテンツマニフェストから解決し、解決できない場合は元のリンクテキストをラベルにした仮想ノード（`data-node-virtual="true"`）にします。
-
-## 描画
-
-`render` で描画する場所を選びます。
-
-| モード | 動作 |
-| --- | --- |
-| `"build"`（既定） | ビルド時に SVG を生成し、記事に埋め込みます |
-| `"client"` | `div.rb-excalibrain__canvas` にグラフとレイアウトのペイロードをエスケープして持ち、`initExcaliBrain()` がブラウザで SVG を生成します |
-| `"both"` | 埋め込み SVG とクライアント側の描画を併用します（プログレッシブエンハンスメント） |
-
-### 差し込み方
-
-- ` ```excalibrain ` フェンスがある場合は、そのプレースホルダーをマップに置き換えます。
-- フェンスがなく、`auto` が有効で関係が 1 つ以上ある場合は、記事 HTML の末尾にマップのセクションを追加します（マニフェストのエントリとキャッシュ済みの記事 HTML の両方を更新します）。
-
-`heading` と `headingText` は任意の `<h2>` を制御します。
-
-## オプション
-
-| 項目 | 型 | 既定値 | 説明 |
-| --- | --- | --- | --- |
-| `render` | `"build" \| "client" \| "both"` | `"build"` | 描画する場所 |
-| `auto` | `boolean` | `true` | フェンスがないノートにマップを追加する |
-| `heading` | `boolean` | `true` | 見出しを表示する |
-| `headingText` | `string` | `"ExcaliBrain"` | 見出しの文字列 |
-| `className` | `string` | `"rb-excalibrain"` | ルートの CSS クラス |
-| `maxPerRegion` | `number` | `8` | 領域ごとの最大ノード数 |
-| `infer` | `boolean` | `true` | リンクから関係を推論する |
-| `siblings` | `boolean` | `true` | 親から兄弟を推論する |
-| `ontology` | object | — | オントロジーの部分的な上書き |
-| `showHidden` | `boolean` | `false` | `hidden` のノートも含める |
-| `width` | `number` | `720` | SVG viewBox の幅 |
-| `height` | `number` | `480` | SVG viewBox の高さ |
-| `language` | `string` | `"excalibrain"` | 対象にするフェンス言語 |
-
-## 出力
-
-```html
-<section class="rb-excalibrain" data-excalibrain
-         data-excalibrain-render="build"
-         data-excalibrain-center="notes/center">
-  <h2 class="rb-excalibrain__heading">ExcaliBrain</h2>
-  <div class="rb-excalibrain__canvas">
-    <svg class="rb-excalibrain__svg" viewBox="0 0 720 480" role="img">…</svg>
-  </div>
-</section>
-```
-
-領域は `g.rb-excalibrain__region[data-region]`、ノードは `g.rb-excalibrain__node[data-node-role][data-node-slug][data-relation-type]` で、`<a href>` が `<rect>` と `<text>` を包みます。リンクは `path.rb-excalibrain__link[data-link-role][data-relation-type]` です。
-
-## 主なエクスポート
-
-- `excaliBrain(options?)` / `excaliBrainPlugin`: プラグインを作成する
-- `resolveExcaliBrainOptions(options?)`: 既定値を解決する
-- `buildExcaliBrainGraph(input)`: 純粋なグラフ構築
-- `layoutExcaliBrain(graph, options?)`: 決定的なレイアウト
-- `renderExcaliBrainSvg(graph, layout, options?)`: 純粋な SVG 描画
-- 型: `ExcaliBrainOptions`、`ExcaliBrainGraph`、`ExcaliBrainNode`、`ExcaliBrainLink`、`ExcaliBrainLayout`、`ExcaliBrainRole`、`ExcaliBrainRenderMode` ほか
-
-## 関連資料
-
-- [プラグインシステム](../../../docs/ja/plugin-system.md)
+# @riebeckite/plugin-excalibrain
+
+ノートの関係を構造化して表示するプラグインです。[ExcaliBrain](https://github.com/zsviczian/excalibrain)（Zsolt Viczián）の考え方をモデルにしています。
+
+[English](./README.md)
+
+## 概要
+
+`excaliBrain()` はノートごとに 7 つの領域を持つマップを描画します。
+
+| 領域 | 位置 | ロール |
+| --- | --- | --- |
+| Parents | 上 | `parent` |
+| Children | 下 | `child` |
+| Left friends | 左 | `leftFriend` |
+| Right friends | 右 | `rightFriend` |
+| Previous | 左端 | `previous` |
+| Next | 右端 | `next` |
+| Siblings | 周辺 | `sibling` |
+
+関係は ExcaliBrain のオントロジーに従い、YAML フロントマターと本文中の Dataview インラインフィールドから取得します。明示されていない関係は、コンテンツグラフから推論します。
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { excaliBrain } from "@riebeckite/plugin-excalibrain";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    excaliBrain({
+      render: "build",
+    }),
+  ],
+});
+```
+
+このプラグインは `order: -10` で実行されます。
+
+## 関係の書き方
+
+明示した関係は推論より優先されます。
+
+### YAML フロントマター
+
+```md
+---
+title: ExcaliBrain Center
+parent: "[[excalibrain-parent]]"
+children: ["[[excalibrain-child-a]]", "[[excalibrain-child-b]]"]
+---
+```
+
+### Dataview インラインフィールド
+
+```md
+children:: [[excalibrain-child]]
+
+related:: [[note-a]] and [[note-b]] are similar
+```
+
+フィールドは単独行でも、`[field:: [[target]]]` のように角括弧で囲んでも認識します。
+
+### オントロジー
+
+フィールド名は大文字小文字を区別せず、空白はハイフンに正規化して照合します。既定のオントロジーは次のとおりです。
+
+| ロール | フィールド名 |
+| --- | --- |
+| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception` |
+| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to` |
+| `leftFriends` | `friends`, `friend`, `similar`, `supports`, `alternatives`, `advantages` |
+| `rightFriends` | `opposes`, `disadvantages`, `missing`, `cons` |
+| `previous` | `previous`, `prev`, `west`, `w`, `before` |
+| `next` | `next`, `n`, `east`, `e`, `after` |
+| `hidden` | `hidden` |
+
+`ontology` オプションは既定のオントロジーを拡張します。各ロールのフィールド名は、そのロールの既定値を置き換えるのではなく末尾に追加されます。既存のフィールドを別のロールに追加することもできますが、正規の順序（`parents`、`children`、`leftFriends`、`rightFriends`、`previous`、`next`、`hidden`）で先に現れるロールが優先されます。
+
+## 推論
+
+`infer` が有効な場合（既定）、次のように推論します。
+
+- このノートから相手へのリンクは `child`
+- 相手からこのノートへのバックリンクは `parent`
+- 相互リンクは `leftFriend`
+
+`siblings` が有効な場合（既定）、親ノートの他の子ノートを `sibling` として追加します。兄弟の推論には `infer` も必要で、`infer: false` にすると無効になります。リンク先はコンテンツマニフェストから解決し、解決できない場合は元のリンクテキストをラベルにした仮想ノード（`data-node-virtual="true"`）にします。
+
+## 描画
+
+`render` で描画する場所を選びます。
+
+| モード | 動作 |
+| --- | --- |
+| `"build"`（既定） | ビルド時に SVG を生成し、記事に埋め込みます |
+| `"client"` | `div.rb-excalibrain__canvas` にグラフとレイアウトのペイロードをエスケープして持ち、`initExcaliBrain()` がブラウザで SVG を生成します |
+| `"both"` | 埋め込み SVG とクライアント側の描画を併用します（プログレッシブエンハンスメント） |
+
+### 差し込み方
+
+- ` ```excalibrain ` フェンスがある場合は、そのプレースホルダーをマップに置き換えます。
+- フェンスがなく、`auto` が有効で関係が 1 つ以上ある場合は、記事 HTML の末尾にマップのセクションを追加します（マニフェストのエントリとキャッシュ済みの記事 HTML の両方を更新します）。
+
+`heading` と `headingText` は任意の `<h2>` を制御します。
+
+## オプション
+
+| 項目 | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `render` | `"build" \| "client" \| "both"` | `"build"` | 描画する場所 |
+| `auto` | `boolean` | `true` | フェンスがないノートにマップを追加する |
+| `heading` | `boolean` | `true` | 見出しを表示する |
+| `headingText` | `string` | `"ExcaliBrain"` | 見出しの文字列 |
+| `className` | `string` | `"rb-excalibrain"` | ルートの CSS クラス |
+| `maxPerRegion` | `number` | `8` | 領域ごとの最大ノード数 |
+| `infer` | `boolean` | `true` | リンクから関係を推論する |
+| `siblings` | `boolean` | `true` | 親から兄弟を推論する（`infer` が必要） |
+| `ontology` | object | — | ロールごとに末尾追加するオントロジーのフィールド名 |
+| `showHidden` | `boolean` | `false` | `hidden` のノートも含める |
+| `width` | `number` | `720` | SVG viewBox の幅 |
+| `height` | `number` | `480` | SVG viewBox の高さ |
+| `language` | `string` | `"excalibrain"` | 対象にするフェンス言語 |
+
+## 出力
+
+```html
+<section class="rb-excalibrain" data-excalibrain
+         data-excalibrain-render="build"
+         data-excalibrain-center="notes/center">
+  <h2 class="rb-excalibrain__heading">ExcaliBrain</h2>
+  <div class="rb-excalibrain__canvas">
+    <svg class="rb-excalibrain__svg" viewBox="0 0 720 480" role="img">…</svg>
+  </div>
+</section>
+```
+
+領域は `g.rb-excalibrain__region[data-region]`、ノードは `g.rb-excalibrain__node[data-node-role][data-node-slug][data-relation-type]` で、`<a href>` が `<rect>` と `<text>` を包みます。リンクは `path.rb-excalibrain__link[data-link-role][data-relation-type]` です。
+
+## 主なエクスポート
+
+- `excaliBrain(options?)` / `excaliBrainPlugin`: プラグインを作成する
+- `resolveExcaliBrainOptions(options?)`: 既定値を解決する
+- `buildExcaliBrainGraph(input)`: 純粋なグラフ構築
+- `layoutExcaliBrain(graph, options?)`: 決定的なレイアウト
+- `renderExcaliBrainSvg(graph, layout, options?)`: 純粋な SVG 描画
+- 型: `ExcaliBrainOptions`、`ExcaliBrainGraph`、`ExcaliBrainNode`、`ExcaliBrainLink`、`ExcaliBrainLayout`、`ExcaliBrainRole`、`ExcaliBrainRenderMode` ほか
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import type { ExcaliBrainOptions } from "./src/types.js";
 export { buildExcaliBrainGraph } from "./src/graph.js";
 export { layoutExcaliBrain } from "./src/layout.js";
-export { renderExcaliBrainSection, renderExcaliBrainSvg, } from "./src/render.js";
-export { resolveExcaliBrainOptions, validateExcaliBrainOptions, } from "./src/options.js";
-export type { ResolvedExcaliBrainOptions } from "./src/options.js";
-export { collectDefinedRelations, DEFAULT_ONTOLOGY, isNoteHidden, normalizeFieldName, resolveOntology, } from "./src/ontology.js";
 export type { DefinedRelation, ResolvedOntology, } from "./src/ontology.js";
+export { collectDefinedRelations, DEFAULT_ONTOLOGY, isNoteHidden, normalizeFieldName, resolveOntology, } from "./src/ontology.js";
+export type { ResolvedExcaliBrainOptions } from "./src/options.js";
+export { resolveExcaliBrainOptions, validateExcaliBrainOptions, } from "./src/options.js";
+export { renderExcaliBrainSection, renderExcaliBrainSvg, } from "./src/render.js";
 export type { ExcaliBrainBuildInput, ExcaliBrainClientOptions, ExcaliBrainGraph, ExcaliBrainLayout, ExcaliBrainLink, ExcaliBrainNode, ExcaliBrainNodeRole, ExcaliBrainOntology, ExcaliBrainOptions, ExcaliBrainPositionedLink, ExcaliBrainPositionedNode, ExcaliBrainRegion, ExcaliBrainRelationType, ExcaliBrainRenderMode, ExcaliBrainRole, } from "./src/types.js";
 export declare function excaliBrain(options?: ExcaliBrainOptions): import("@riebeckite/core").RiebeckitePlugin<ExcaliBrainOptions>;
 export declare const excaliBrainPlugin: typeof excaliBrain;

package/dist/index.js

@@ -53,9 +53,14 @@ function normalizeFieldName(value) {
 }
 function resolveOntology(overrides = {}) {
   const merged = {
-    ...DEFAULT_ONTOLOGY,
-    ...overrides
+    ...DEFAULT_ONTOLOGY
   };
+  for (const role of FIELD_ROLE_ORDER) {
+    const extra = overrides[role];
+    if (extra && extra.length > 0) {
+      merged[role] = [...DEFAULT_ONTOLOGY[role], ...extra];
+    }
+  }
   const fieldRole = /* @__PURE__ */ new Map();
   for (const role of FIELD_ROLE_ORDER) {
     for (const field of merged[role] ?? []) {
@@ -171,7 +176,13 @@ function validateExcaliBrainOptions(options) {
       message: 'Expected "build", "client", or "both".'
     });
   }
-  for (const key of ["auto", "heading", "infer", "siblings", "showHidden"]) {
+  for (const key of [
+    "auto",
+    "heading",
+    "infer",
+    "siblings",
+    "showHidden"
+  ]) {
     if (options[key] !== void 0 && typeof options[key] !== "boolean") {
       issues.push({ path: key, message: "Expected a boolean." });
     }
@@ -259,10 +270,7 @@ function buildExcaliBrainGraph(input) {
   })) {
     add(relation.target, relation.role, "defined");
   }
-  const outgoing = noteLinkSlugs(
-    manifest.outgoingLinks.get(slug) ?? [],
-    slug
-  );
+  const outgoing = noteLinkSlugs(manifest.outgoingLinks.get(slug) ?? [], slug);
   const incoming = unique(
     (manifest.incomingLinks.get(slug) ?? []).filter(
       (candidate) => candidate !== slug
@@ -280,7 +288,7 @@ function buildExcaliBrainGraph(input) {
     }
     for (const target of mutual) add(target, "leftFriend", "inferred");
   }
-  if (options.siblings) {
+  if (options.infer && options.siblings) {
     const parents = [...relations.values()].filter(
       (relation) => relation.role === "parent"
     );
@@ -297,14 +305,12 @@ function buildExcaliBrainGraph(input) {
     }
   }
   const nodes = [...relations.values()].map((relation) => relation.node);
-  const links = [...relations.values()].map(
-    (relation) => ({
-      from: slug,
-      to: relation.node.id,
-      role: relation.role,
-      relationType: relation.relationType
-    })
-  );
+  const links = [...relations.values()].map((relation) => ({
+    from: slug,
+    to: relation.node.id,
+    role: relation.role,
+    relationType: relation.relationType
+  }));
   return { center, nodes, links };
 }
 function resolveNode(target, selfSlug, manifest) {
@@ -451,9 +457,7 @@ function layoutExcaliBrain(graph, options = {}) {
     const radius = anchor.radius === "far" ? farRadius : nearRadius;
     group.forEach((node, index) => {
       const angle = spreadAngle(anchor.angle, index, group.length);
-      positioned.push(
-        positionNode(node, angle, radius, cx, cy, width, height)
-      );
+      positioned.push(positionNode(node, angle, radius, cx, cy, width, height));
     });
   }
   const ids = new Set(positioned.map((node) => node.id));
@@ -562,6 +566,52 @@ function replaceExcaliBrainPlaceholders(html, replacement) {
   return html.replace(createExcaliBrainPlaceholderPattern(), replacement);
 }
 
+// src/rehype.ts
+function rehypeExcaliBrain(options = {}) {
+  const language = options.language ?? "excalibrain";
+  return (tree) => {
+    replaceBlocks(tree, language);
+  };
+}
+function replaceBlocks(node, language) {
+  const children = getChildren(node);
+  if (!children) return;
+  for (let index = 0; index < children.length; index += 1) {
+    const child = children[index];
+    if (child === void 0) continue;
+    if (isExcaliBrainBlock(child, language)) {
+      children[index] = {
+        type: "raw",
+        value: createExcaliBrainPlaceholder()
+      };
+      continue;
+    }
+    replaceBlocks(child, language);
+  }
+}
+function isExcaliBrainBlock(node, language) {
+  const element = asElement(node);
+  if (element?.tagName !== "pre") return false;
+  const code = getChildren(element)?.find(
+    (child) => asElement(child)?.tagName === "code"
+  );
+  if (!code) return false;
+  return classList(code).includes(`language-${language}`);
+}
+function asElement(node) {
+  return node.type === "element" ? node : null;
+}
+function getChildren(node) {
+  const children = node.children;
+  return Array.isArray(children) ? children : null;
+}
+function classList(node) {
+  const value = node.properties?.className;
+  if (Array.isArray(value)) return value.map(String);
+  if (typeof value === "string") return value.split(/\s+/);
+  return [];
+}
+
 // src/render.ts
 var ROLE_ATTRIBUTE = {
   parent: "parent",
@@ -652,52 +702,6 @@ function escapeAttribute(value) {
   return escapeHtml(value).replace(/"/g, "&quot;").replace(/'/g, "&#39;");
 }
 
-// src/rehype.ts
-function rehypeExcaliBrain(options = {}) {
-  const language = options.language ?? "excalibrain";
-  return (tree) => {
-    replaceBlocks(tree, language);
-  };
-}
-function replaceBlocks(node, language) {
-  const children = getChildren(node);
-  if (!children) return;
-  for (let index = 0; index < children.length; index += 1) {
-    const child = children[index];
-    if (child === void 0) continue;
-    if (isExcaliBrainBlock(child, language)) {
-      children[index] = {
-        type: "raw",
-        value: createExcaliBrainPlaceholder()
-      };
-      continue;
-    }
-    replaceBlocks(child, language);
-  }
-}
-function isExcaliBrainBlock(node, language) {
-  const element = asElement(node);
-  if (element?.tagName !== "pre") return false;
-  const code = getChildren(element)?.find(
-    (child) => asElement(child)?.tagName === "code"
-  );
-  if (!code) return false;
-  return classList(code).includes(`language-${language}`);
-}
-function asElement(node) {
-  return node.type === "element" ? node : null;
-}
-function getChildren(node) {
-  const children = node.children;
-  return Array.isArray(children) ? children : null;
-}
-function classList(node) {
-  const value = node.properties?.className;
-  if (Array.isArray(value)) return value.map(String);
-  if (typeof value === "string") return value.split(/\s+/);
-  return [];
-}
-
 // index.ts
 var SECTION_ATTRIBUTE = "data-excalibrain";
 function createExcaliBrainRuntime(options) {

package/dist/src/ontology.d.ts

@@ -1,4 +1,4 @@
-import type { ExcaliBrainOntology, ExcaliBrainNodeRole } from "./types.js";
+import type { ExcaliBrainNodeRole, ExcaliBrainOntology } from "./types.js";
 export type ExcaliBrainFieldRole = "parents" | "children" | "leftFriends" | "rightFriends" | "previous" | "next" | "hidden";
 /** ExcaliBrain's default ontology field names. */
 export declare const DEFAULT_ONTOLOGY: Required<ExcaliBrainOntology>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-excalibrain",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,7 +21,11 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.3"
+    "@riebeckite/core": "0.0.6"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4",
+    "@riebeckite/test": "0.0.6"
   },
   "publishConfig": {
     "access": "public"
@@ -56,6 +60,7 @@
     "./style.css"
   ],
   "scripts": {
-    "build": "node ../../../scripts/build_package.mjs"
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
   }
 }

package/style.css

@@ -1,94 +1,95 @@
-.rb-excalibrain {
-  --rb-excalibrain-ink: var(--rb-color-ink, #000000);
-  --rb-excalibrain-paper: var(--rb-color-paper, #ffffff);
-  --rb-excalibrain-muted: var(--rb-color-muted, #69645c);
-  --rb-excalibrain-accent: var(--rb-color-accent, #686868);
-  --rb-excalibrain-rule: var(
-    --rb-color-border,
-    color-mix(in srgb, var(--rb-excalibrain-ink) 18%, transparent)
-  );
-  --rb-excalibrain-surface: color-mix(
-    in srgb,
-    var(--rb-excalibrain-paper) 95%,
-    var(--rb-excalibrain-ink)
-  );
-
-  margin: 2rem 0;
-  color: var(--rb-excalibrain-ink);
-}
-
-.rb-excalibrain__heading {
-  margin: 0 0 0.5rem;
-  font-size: 1rem;
-  font-weight: 700;
-  letter-spacing: 0.02em;
-  text-transform: uppercase;
-}
-
-.rb-excalibrain__canvas {
-  overflow: auto;
-  border: 1px solid var(--rb-excalibrain-rule);
-  background: var(--rb-excalibrain-surface);
-}
-
-.rb-excalibrain__svg {
-  display: block;
-  width: 100%;
-  min-width: 32rem;
-  height: auto;
-}
-
-.rb-excalibrain__link {
-  fill: none;
-  stroke: var(--rb-excalibrain-rule);
-  stroke-width: 1.25;
-}
-
-.rb-excalibrain__link[data-relation-type="defined"] {
-  stroke: var(--rb-excalibrain-accent);
-}
-
-.rb-excalibrain__node-box {
-  fill: var(--rb-excalibrain-paper);
-  stroke: var(--rb-excalibrain-rule);
-  stroke-width: 1.25;
-}
-
-.rb-excalibrain__node[data-node-role="center"] .rb-excalibrain__node-box {
-  stroke: var(--rb-excalibrain-ink);
-  stroke-width: 2;
-}
-
-.rb-excalibrain__node[data-node-virtual="true"] .rb-excalibrain__node-box {
-  fill: none;
-  stroke-dasharray: 4 3;
-}
-
-.rb-excalibrain__node-label {
-  fill: var(--rb-excalibrain-ink);
-  font-size: 0.8125rem;
-}
-
-.rb-excalibrain__node-link {
-  text-decoration: none;
-}
-
-.rb-excalibrain__node-link:hover .rb-excalibrain__node-box,
-.rb-excalibrain__node-link:focus-visible .rb-excalibrain__node-box {
-  stroke: var(--rb-excalibrain-accent);
-  stroke-width: 2;
-}
-
-.rb-excalibrain[data-excalibrain-render="client"] .rb-excalibrain__canvas:empty::before {
-  display: block;
-  padding: 1rem;
-  content: "ExcaliBrain map is rendered in the browser.";
-  color: var(--rb-excalibrain-muted);
-  font-size: 0.8125rem;
-}
-
-html[data-theme="dark"] .rb-excalibrain,
-html.dark .rb-excalibrain {
-  --rb-excalibrain-ink: var(--rb-color-paper, #ffffff);
-  --rb-excalibrain-paper: var(--rb-color-ink, #000000);
-}
+.rb-excalibrain {
+  --rb-excalibrain-ink: var(--rb-color-ink, #000000);
+  --rb-excalibrain-paper: var(--rb-color-paper, #ffffff);
+  --rb-excalibrain-muted: var(--rb-color-muted, #69645c);
+  --rb-excalibrain-accent: var(--rb-color-accent, #686868);
+  --rb-excalibrain-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rb-excalibrain-ink) 18%, transparent)
+  );
+  --rb-excalibrain-surface: color-mix(
+    in srgb,
+    var(--rb-excalibrain-paper) 95%,
+    var(--rb-excalibrain-ink)
+  );
+
+  margin: 2rem 0;
+  color: var(--rb-excalibrain-ink);
+}
+
+.rb-excalibrain__heading {
+  margin: 0 0 0.5rem;
+  font-size: 1rem;
+  font-weight: 700;
+  letter-spacing: 0.02em;
+  text-transform: uppercase;
+}
+
+.rb-excalibrain__canvas {
+  overflow: auto;
+  border: 1px solid var(--rb-excalibrain-rule);
+  background: var(--rb-excalibrain-surface);
+}
+
+.rb-excalibrain__svg {
+  display: block;
+  width: 100%;
+  min-width: 32rem;
+  height: auto;
+}
+
+.rb-excalibrain__link {
+  fill: none;
+  stroke: var(--rb-excalibrain-rule);
+  stroke-width: 1.25;
+}
+
+.rb-excalibrain__link[data-relation-type="defined"] {
+  stroke: var(--rb-excalibrain-accent);
+}
+
+.rb-excalibrain__node-box {
+  fill: var(--rb-excalibrain-paper);
+  stroke: var(--rb-excalibrain-rule);
+  stroke-width: 1.25;
+}
+
+.rb-excalibrain__node[data-node-role="center"] .rb-excalibrain__node-box {
+  stroke: var(--rb-excalibrain-ink);
+  stroke-width: 2;
+}
+
+.rb-excalibrain__node[data-node-virtual="true"] .rb-excalibrain__node-box {
+  fill: none;
+  stroke-dasharray: 4 3;
+}
+
+.rb-excalibrain__node-label {
+  fill: var(--rb-excalibrain-ink);
+  font-size: 0.8125rem;
+}
+
+.rb-excalibrain__node-link {
+  text-decoration: none;
+}
+
+.rb-excalibrain__node-link:hover .rb-excalibrain__node-box,
+.rb-excalibrain__node-link:focus-visible .rb-excalibrain__node-box {
+  stroke: var(--rb-excalibrain-accent);
+  stroke-width: 2;
+}
+
+.rb-excalibrain[data-excalibrain-render="client"]
+  .rb-excalibrain__canvas:empty::before {
+  display: block;
+  padding: 1rem;
+  content: "ExcaliBrain map is rendered in the browser.";
+  color: var(--rb-excalibrain-muted);
+  font-size: 0.8125rem;
+}
+
+html[data-theme="dark"] .rb-excalibrain,
+html.dark .rb-excalibrain {
+  --rb-excalibrain-ink: var(--rb-color-paper, #ffffff);
+  --rb-excalibrain-paper: var(--rb-color-ink, #000000);
+}