@riebeckite/plugin-wavedrom 0.0.11 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +124 -124
  2. package/README_ja.md +124 -124
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,124 +1,124 @@
1
- # @riebeckite/plugin-wavedrom
2
-
3
- Renders ` ```wavedrom ` code blocks as [WaveDrom](https://wavedrom.com/) timing diagrams.
4
-
5
- [日本語](./README_ja.md)
6
-
7
- ## Overview
8
-
9
- `wavedrom()` replaces ` ```wavedrom ` (and ` ```wavejson `) code blocks with a `<figure>` that carries the normalized WaveJSON in a `data-wavedrom-spec` attribute. The diagram itself is drawn in the browser by `initWaveDrom`, which dynamically imports `wavedrom`. The build only emits markup. Execution order is `order: -10`.
10
-
11
- ## Configuration
12
-
13
- ```ts
14
- import { defineConfig } from "@riebeckite/core";
15
- import { wavedrom } from "@riebeckite/plugin-wavedrom";
16
-
17
- export default defineConfig({
18
- // ...
19
- plugins: [
20
- wavedrom({
21
- skin: "default",
22
- caption: true,
23
- }),
24
- ],
25
- });
26
- ```
27
-
28
- ## Writing a diagram
29
-
30
- The block body is a **strict JSON** WaveJSON object. Keys must be double-quoted, and trailing commas or comments are not allowed.
31
-
32
- ````markdown
33
- ```wavedrom
34
- {
35
- "signal": [
36
- { "name": "clk", "wave": "p......" },
37
- { "name": "bus", "wave": "x.34.5x", "data": "head body tail" },
38
- { "name": "wire", "wave": "0.1..0." }
39
- ]
40
- }
41
- ```
42
- ````
43
-
44
- Top-level keys other than `signal`, `assign`, and `reg` — such as WaveDrom's `head`, `config`, and `foot` — are passed through unchanged.
45
-
46
- ```wavedrom
47
- {
48
- "head": { "text": "handshake" },
49
- "signal": [
50
- { "name": "req", "wave": "01..0" },
51
- { "name": "ack", "wave": "0.1.0" }
52
- ]
53
- }
54
- ```
55
-
56
- ### Captions
57
-
58
- A caption is taken from the code block's `title`.
59
-
60
- ````markdown
61
- ```wavedrom title="Read cycle"
62
- { "signal": [{ "name": "clk", "wave": "p..." }] }
63
- ```
64
- ````
65
-
66
- You can also use a top-level `"caption"` key in the JSON. It is removed before the diagram is rendered, so it never reaches WaveDrom.
67
-
68
- ````markdown
69
- ```wavedrom
70
- {
71
- "caption": "Read cycle",
72
- "signal": [{ "name": "clk", "wave": "p..." }]
73
- }
74
- ```
75
- ````
76
-
77
- ## Output
78
-
79
- ```html
80
- <figure class="rb-wavedrom" data-wavedrom="pending" data-wavedrom-spec="{&quot;signal&quot;:[...]}" data-wavedrom-skin="default">
81
- <figcaption id="rb-wavedrom-xxxx-caption" class="rb-wavedrom__caption">Read cycle</figcaption>
82
- <div class="rb-wavedrom__canvas" data-wavedrom-canvas="true" role="img" aria-labelledby="rb-wavedrom-xxxx-caption"></div>
83
- <details class="rb-wavedrom__fallback">
84
- <summary>WaveJSON source</summary>
85
- <pre><code>{ ... }</code></pre>
86
- </details>
87
- </figure>
88
- ```
89
-
90
- - `.rb-wavedrom` — the figure wrapper; inherits `--rb-color-*` for theming
91
- - `.rb-wavedrom__canvas` — where WaveDrom draws the SVG; marked with `data-wavedrom-canvas="true"`
92
- - `.rb-wavedrom__caption` — the `<figcaption>` when a caption is present
93
- - `.rb-wavedrom__fallback` — a `<details>` holding the WaveJSON source
94
-
95
- The `data-wavedrom` attribute reports render state: `pending` initially, `rendered` on success, and `error` on failure. On failure the fallback `<details>` is opened.
96
-
97
- ## Options
98
-
99
- | Name | Type | Default | Description |
100
- | --- | --- | --- | --- |
101
- | `skin` | `"default" \| "narrow" \| "lowkey"` | `"default"` | WaveDrom skin used by the browser renderer |
102
- | `caption` | `boolean` | `true` | Render the extracted caption as a `<figcaption>` |
103
- | `fallback` | `boolean` | `true` | Render the WaveJSON source in a `<details>` block |
104
- | `className` | `string` | `"rb-wavedrom"` | Base class applied to the figure |
105
-
106
- ## Diagnostics
107
-
108
- If the body is not valid JSON, is not an object, or has no `signal` / `assign` / `reg`, the original code block is left in place and a diagnostic is emitted with `source: "@riebeckite/plugin-wavedrom"` and `ruleId: "invalid-config"`.
109
-
110
- ## Client rendering
111
-
112
- `wavedrom` is not bundled at build time. The site's client bundle must call `initWaveDrom`, which `wavedrom()` wires up via `createClientEntry`. The initializer finds `figure[data-wavedrom="pending"]`, `JSON.parse`s each `data-wavedrom-spec`, dynamically imports `wavedrom`, and draws the SVG into `<div class="rb-wavedrom__canvas">` with `WaveDrom.RenderWaveForm`. When `data-wavedrom-skin` is present, the matching skin is loaded. A broken payload or a rendering error only marks that figure as `data-wavedrom="error"` and opens its fallback.
113
-
114
- ## Limitations
115
-
116
- - Rendering is client-only. Without JavaScript the SVG is never produced and only the WaveJSON source remains
117
- - The E2E build checks the emitted markup only; actual rendering requires a browser
118
- - The body must be strict JSON. The JSON5 form accepted by the WaveDrom editor (unquoted keys, single quotes, comments) is not supported
119
- - The WaveJSON is embedded directly in an HTML attribute, so keep diagrams reasonably small
120
- - Only the `wavedrom` and `wavejson` info strings are recognized; other languages are unaffected
121
-
122
- ## See also
123
-
124
- - [Plugin system](../../../docs/en/plugin-system.md)
1
+ # @riebeckite/plugin-wavedrom
2
+
3
+ Renders ` ```wavedrom ` code blocks as [WaveDrom](https://wavedrom.com/) timing diagrams.
4
+
5
+ [日本語](./README_ja.md)
6
+
7
+ ## Overview
8
+
9
+ `wavedrom()` replaces ` ```wavedrom ` (and ` ```wavejson `) code blocks with a `<figure>` that carries the normalized WaveJSON in a `data-wavedrom-spec` attribute. The diagram itself is drawn in the browser by `initWaveDrom`, which dynamically imports `wavedrom`. The build only emits markup. Execution order is `order: -10`.
10
+
11
+ ## Configuration
12
+
13
+ ```ts
14
+ import { defineConfig } from "@riebeckite/core";
15
+ import { wavedrom } from "@riebeckite/plugin-wavedrom";
16
+
17
+ export default defineConfig({
18
+ // ...
19
+ plugins: [
20
+ wavedrom({
21
+ skin: "default",
22
+ caption: true,
23
+ }),
24
+ ],
25
+ });
26
+ ```
27
+
28
+ ## Writing a diagram
29
+
30
+ The block body is a **strict JSON** WaveJSON object. Keys must be double-quoted, and trailing commas or comments are not allowed.
31
+
32
+ ````markdown
33
+ ```wavedrom
34
+ {
35
+ "signal": [
36
+ { "name": "clk", "wave": "p......" },
37
+ { "name": "bus", "wave": "x.34.5x", "data": "head body tail" },
38
+ { "name": "wire", "wave": "0.1..0." }
39
+ ]
40
+ }
41
+ ```
42
+ ````
43
+
44
+ Top-level keys other than `signal`, `assign`, and `reg` — such as WaveDrom's `head`, `config`, and `foot` — are passed through unchanged.
45
+
46
+ ```wavedrom
47
+ {
48
+ "head": { "text": "handshake" },
49
+ "signal": [
50
+ { "name": "req", "wave": "01..0" },
51
+ { "name": "ack", "wave": "0.1.0" }
52
+ ]
53
+ }
54
+ ```
55
+
56
+ ### Captions
57
+
58
+ A caption is taken from the code block's `title`.
59
+
60
+ ````markdown
61
+ ```wavedrom title="Read cycle"
62
+ { "signal": [{ "name": "clk", "wave": "p..." }] }
63
+ ```
64
+ ````
65
+
66
+ You can also use a top-level `"caption"` key in the JSON. It is removed before the diagram is rendered, so it never reaches WaveDrom.
67
+
68
+ ````markdown
69
+ ```wavedrom
70
+ {
71
+ "caption": "Read cycle",
72
+ "signal": [{ "name": "clk", "wave": "p..." }]
73
+ }
74
+ ```
75
+ ````
76
+
77
+ ## Output
78
+
79
+ ```html
80
+ <figure class="rb-wavedrom" data-wavedrom="pending" data-wavedrom-spec="{&quot;signal&quot;:[...]}" data-wavedrom-skin="default">
81
+ <figcaption id="rb-wavedrom-xxxx-caption" class="rb-wavedrom__caption">Read cycle</figcaption>
82
+ <div class="rb-wavedrom__canvas" data-wavedrom-canvas="true" role="img" aria-labelledby="rb-wavedrom-xxxx-caption"></div>
83
+ <details class="rb-wavedrom__fallback">
84
+ <summary>WaveJSON source</summary>
85
+ <pre><code>{ ... }</code></pre>
86
+ </details>
87
+ </figure>
88
+ ```
89
+
90
+ - `.rb-wavedrom` — the figure wrapper; inherits `--rb-color-*` for theming
91
+ - `.rb-wavedrom__canvas` — where WaveDrom draws the SVG; marked with `data-wavedrom-canvas="true"`
92
+ - `.rb-wavedrom__caption` — the `<figcaption>` when a caption is present
93
+ - `.rb-wavedrom__fallback` — a `<details>` holding the WaveJSON source
94
+
95
+ The `data-wavedrom` attribute reports render state: `pending` initially, `rendered` on success, and `error` on failure. On failure the fallback `<details>` is opened.
96
+
97
+ ## Options
98
+
99
+ | Name | Type | Default | Description |
100
+ | --- | --- | --- | --- |
101
+ | `skin` | `"default" \| "narrow" \| "lowkey"` | `"default"` | WaveDrom skin used by the browser renderer |
102
+ | `caption` | `boolean` | `true` | Render the extracted caption as a `<figcaption>` |
103
+ | `fallback` | `boolean` | `true` | Render the WaveJSON source in a `<details>` block |
104
+ | `className` | `string` | `"rb-wavedrom"` | Base class applied to the figure |
105
+
106
+ ## Diagnostics
107
+
108
+ If the body is not valid JSON, is not an object, or has no `signal` / `assign` / `reg`, the original code block is left in place and a diagnostic is emitted with `source: "@riebeckite/plugin-wavedrom"` and `ruleId: "invalid-config"`.
109
+
110
+ ## Client rendering
111
+
112
+ `wavedrom` is not bundled at build time. The site's client bundle must call `initWaveDrom`, which `wavedrom()` wires up via `createClientEntry`. The initializer finds `figure[data-wavedrom="pending"]`, `JSON.parse`s each `data-wavedrom-spec`, dynamically imports `wavedrom`, and draws the SVG into `<div class="rb-wavedrom__canvas">` with `WaveDrom.RenderWaveForm`. When `data-wavedrom-skin` is present, the matching skin is loaded. A broken payload or a rendering error only marks that figure as `data-wavedrom="error"` and opens its fallback.
113
+
114
+ ## Limitations
115
+
116
+ - Rendering is client-only. Without JavaScript the SVG is never produced and only the WaveJSON source remains
117
+ - The E2E build checks the emitted markup only; actual rendering requires a browser
118
+ - The body must be strict JSON. The JSON5 form accepted by the WaveDrom editor (unquoted keys, single quotes, comments) is not supported
119
+ - The WaveJSON is embedded directly in an HTML attribute, so keep diagrams reasonably small
120
+ - Only the `wavedrom` and `wavejson` info strings are recognized; other languages are unaffected
121
+
122
+ ## See also
123
+
124
+ - [Plugin system](../../../docs/en/reference/plugin-api.md)
package/README_ja.md CHANGED
@@ -1,124 +1,124 @@
1
- # @riebeckite/plugin-wavedrom
2
-
3
- ` ```wavedrom ` コードブロックを [WaveDrom](https://wavedrom.com/) のタイミング図として表示するプラグインです。
4
-
5
- [English](./README.md)
6
-
7
- ## 概要
8
-
9
- `wavedrom()` は ` ```wavedrom `（および ` ```wavejson `）のコードブロックを `<figure>` に置き換え、正規化した WaveJSON を `data-wavedrom-spec` 属性に埋め込みます。図そのものはブラウザ側の `initWaveDrom` が `wavedrom` を動的 import して描画します。ビルドはマークアップだけを出力します。実行順は `order: -10` です。
10
-
11
- ## 設定する
12
-
13
- ```ts
14
- import { defineConfig } from "@riebeckite/core";
15
- import { wavedrom } from "@riebeckite/plugin-wavedrom";
16
-
17
- export default defineConfig({
18
- // ...
19
- plugins: [
20
- wavedrom({
21
- skin: "default",
22
- caption: true,
23
- }),
24
- ],
25
- });
26
- ```
27
-
28
- ## タイミング図を書く
29
-
30
- 本文は **厳密な JSON** の WaveJSON オブジェクトです。キーは必ず二重引用符で囲み、末尾のカンマやコメントは書けません。
31
-
32
- ````markdown
33
- ```wavedrom
34
- {
35
- "signal": [
36
- { "name": "clk", "wave": "p......" },
37
- { "name": "bus", "wave": "x.34.5x", "data": "head body tail" },
38
- { "name": "wire", "wave": "0.1..0." }
39
- ]
40
- }
41
- ```
42
- ````
43
-
44
- WaveDrom の `head` / `config` / `foot` など、`signal`・`assign`・`reg` 以外のトップレベルキーもそのまま引き継がれます。
45
-
46
- ```wavedrom
47
- {
48
- "head": { "text": "handshake" },
49
- "signal": [
50
- { "name": "req", "wave": "01..0" },
51
- { "name": "ack", "wave": "0.1.0" }
52
- ]
53
- }
54
- ```
55
-
56
- ### キャプション
57
-
58
- キャプションはコードブロックの `title` から取得します。
59
-
60
- ````markdown
61
- ```wavedrom title="読み出しサイクル"
62
- { "signal": [{ "name": "clk", "wave": "p..." }] }
63
- ```
64
- ````
65
-
66
- JSON のトップレベル `"caption"` キーでも指定できます。このキーは図を描画する前に取り除かれるため、WaveDrom には渡りません。
67
-
68
- ````markdown
69
- ```wavedrom
70
- {
71
- "caption": "読み出しサイクル",
72
- "signal": [{ "name": "clk", "wave": "p..." }]
73
- }
74
- ```
75
- ````
76
-
77
- ## 出力
78
-
79
- ```html
80
- <figure class="rb-wavedrom" data-wavedrom="pending" data-wavedrom-spec="{&quot;signal&quot;:[...]}" data-wavedrom-skin="default">
81
- <figcaption id="rb-wavedrom-xxxx-caption" class="rb-wavedrom__caption">読み出しサイクル</figcaption>
82
- <div class="rb-wavedrom__canvas" data-wavedrom-canvas="true" role="img" aria-labelledby="rb-wavedrom-xxxx-caption"></div>
83
- <details class="rb-wavedrom__fallback">
84
- <summary>WaveJSON source</summary>
85
- <pre><code>{ ... }</code></pre>
86
- </details>
87
- </figure>
88
- ```
89
-
90
- - `.rb-wavedrom` — 図全体のラッパー。`--rb-color-*` で配色を引き継ぎます
91
- - `.rb-wavedrom__canvas` — WaveDrom が SVG を描画する領域。`data-wavedrom-canvas="true"`
92
- - `.rb-wavedrom__caption` — キャプションがある場合の `<figcaption>`
93
- - `.rb-wavedrom__fallback` — WaveJSON のソースを表示する `<details>`
94
-
95
- `data-wavedrom` 属性は描画状態を表します。初期値は `pending`、成功時は `rendered`、失敗時は `error` になります。失敗時はフォールバックの `<details>` が開きます。
96
-
97
- ## オプション
98
-
99
- | 項目 | 型 | 既定値 | 説明 |
100
- | --- | --- | --- | --- |
101
- | `skin` | `"default" \| "narrow" \| "lowkey"` | `"default"` | ブラウザ側で使う WaveDrom スキン |
102
- | `caption` | `boolean` | `true` | キャプションを `<figcaption>` として表示する |
103
- | `fallback` | `boolean` | `true` | WaveJSON ソースを `<details>` に表示する |
104
- | `className` | `string` | `"rb-wavedrom"` | figure に付ける基底クラス |
105
-
106
- ## 診断
107
-
108
- 本文が JSON として不正、オブジェクトでない、`signal` / `assign` / `reg` がない場合は、元のコードブロックをそのまま残し、`source: "@riebeckite/plugin-wavedrom"`、`ruleId: "invalid-config"` の診断を出します。
109
-
110
- ## クライアント側の描画
111
-
112
- `wavedrom` はビルド時にはバンドルされません。サイトのクライアントバンドルが `initWaveDrom` を呼ぶ必要があり、`wavedrom()` が `createClientEntry` で結線します。`initWaveDrom` は `figure[data-wavedrom="pending"]` を探し、各 `data-wavedrom-spec` を `JSON.parse` して `wavedrom` を動的 import し、`WaveDrom.RenderWaveForm` で `<div class="rb-wavedrom__canvas">` に SVG を描画します。`data-wavedrom-skin` があれば対応するスキンを読み込みます。パース失敗や描画例外はその figure だけを `data-wavedrom="error"` にし、フォールバックを開きます。
113
-
114
- ## 制限
115
-
116
- - 描画はクライアント専用です。JavaScript が無効な環境では SVG は生成されず、WaveJSON ソースだけが残ります
117
- - E2E のビルドは出力マークアップだけを検査します。実際の描画にはブラウザが必要です
118
- - 本文は厳密な JSON である必要があります。WaveDrom エディタが受け付ける JSON5 形式（引用符なしキー、シングルクォート、コメント）は受理しません
119
- - WaveJSON は HTML 属性に直接埋め込まれるため、巨大な図は避けてください
120
- - 認識するのは `wavedrom` と `wavejson` という info string だけです。他の言語には影響しません
121
-
122
- ## 関連資料
123
-
124
- - [プラグインシステム](../../../docs/ja/plugin-system.md)
1
+ # @riebeckite/plugin-wavedrom
2
+
3
+ ` ```wavedrom ` コードブロックを [WaveDrom](https://wavedrom.com/) のタイミング図として表示するプラグインです。
4
+
5
+ [English](./README.md)
6
+
7
+ ## 概要
8
+
9
+ `wavedrom()` は ` ```wavedrom `（および ` ```wavejson `）のコードブロックを `<figure>` に置き換え、正規化した WaveJSON を `data-wavedrom-spec` 属性に埋め込みます。図そのものはブラウザ側の `initWaveDrom` が `wavedrom` を動的 import して描画します。ビルドはマークアップだけを出力します。実行順は `order: -10` です。
10
+
11
+ ## 設定する
12
+
13
+ ```ts
14
+ import { defineConfig } from "@riebeckite/core";
15
+ import { wavedrom } from "@riebeckite/plugin-wavedrom";
16
+
17
+ export default defineConfig({
18
+ // ...
19
+ plugins: [
20
+ wavedrom({
21
+ skin: "default",
22
+ caption: true,
23
+ }),
24
+ ],
25
+ });
26
+ ```
27
+
28
+ ## タイミング図を書く
29
+
30
+ 本文は **厳密な JSON** の WaveJSON オブジェクトです。キーは必ず二重引用符で囲み、末尾のカンマやコメントは書けません。
31
+
32
+ ````markdown
33
+ ```wavedrom
34
+ {
35
+ "signal": [
36
+ { "name": "clk", "wave": "p......" },
37
+ { "name": "bus", "wave": "x.34.5x", "data": "head body tail" },
38
+ { "name": "wire", "wave": "0.1..0." }
39
+ ]
40
+ }
41
+ ```
42
+ ````
43
+
44
+ WaveDrom の `head` / `config` / `foot` など、`signal`・`assign`・`reg` 以外のトップレベルキーもそのまま引き継がれます。
45
+
46
+ ```wavedrom
47
+ {
48
+ "head": { "text": "handshake" },
49
+ "signal": [
50
+ { "name": "req", "wave": "01..0" },
51
+ { "name": "ack", "wave": "0.1.0" }
52
+ ]
53
+ }
54
+ ```
55
+
56
+ ### キャプション
57
+
58
+ キャプションはコードブロックの `title` から取得します。
59
+
60
+ ````markdown
61
+ ```wavedrom title="読み出しサイクル"
62
+ { "signal": [{ "name": "clk", "wave": "p..." }] }
63
+ ```
64
+ ````
65
+
66
+ JSON のトップレベル `"caption"` キーでも指定できます。このキーは図を描画する前に取り除かれるため、WaveDrom には渡りません。
67
+
68
+ ````markdown
69
+ ```wavedrom
70
+ {
71
+ "caption": "読み出しサイクル",
72
+ "signal": [{ "name": "clk", "wave": "p..." }]
73
+ }
74
+ ```
75
+ ````
76
+
77
+ ## 出力
78
+
79
+ ```html
80
+ <figure class="rb-wavedrom" data-wavedrom="pending" data-wavedrom-spec="{&quot;signal&quot;:[...]}" data-wavedrom-skin="default">
81
+ <figcaption id="rb-wavedrom-xxxx-caption" class="rb-wavedrom__caption">読み出しサイクル</figcaption>
82
+ <div class="rb-wavedrom__canvas" data-wavedrom-canvas="true" role="img" aria-labelledby="rb-wavedrom-xxxx-caption"></div>
83
+ <details class="rb-wavedrom__fallback">
84
+ <summary>WaveJSON source</summary>
85
+ <pre><code>{ ... }</code></pre>
86
+ </details>
87
+ </figure>
88
+ ```
89
+
90
+ - `.rb-wavedrom` — 図全体のラッパー。`--rb-color-*` で配色を引き継ぎます
91
+ - `.rb-wavedrom__canvas` — WaveDrom が SVG を描画する領域。`data-wavedrom-canvas="true"`
92
+ - `.rb-wavedrom__caption` — キャプションがある場合の `<figcaption>`
93
+ - `.rb-wavedrom__fallback` — WaveJSON のソースを表示する `<details>`
94
+
95
+ `data-wavedrom` 属性は描画状態を表します。初期値は `pending`、成功時は `rendered`、失敗時は `error` になります。失敗時はフォールバックの `<details>` が開きます。
96
+
97
+ ## オプション
98
+
99
+ | 項目 | 型 | 既定値 | 説明 |
100
+ | --- | --- | --- | --- |
101
+ | `skin` | `"default" \| "narrow" \| "lowkey"` | `"default"` | ブラウザ側で使う WaveDrom スキン |
102
+ | `caption` | `boolean` | `true` | キャプションを `<figcaption>` として表示する |
103
+ | `fallback` | `boolean` | `true` | WaveJSON ソースを `<details>` に表示する |
104
+ | `className` | `string` | `"rb-wavedrom"` | figure に付ける基底クラス |
105
+
106
+ ## 診断
107
+
108
+ 本文が JSON として不正、オブジェクトでない、`signal` / `assign` / `reg` がない場合は、元のコードブロックをそのまま残し、`source: "@riebeckite/plugin-wavedrom"`、`ruleId: "invalid-config"` の診断を出します。
109
+
110
+ ## クライアント側の描画
111
+
112
+ `wavedrom` はビルド時にはバンドルされません。サイトのクライアントバンドルが `initWaveDrom` を呼ぶ必要があり、`wavedrom()` が `createClientEntry` で結線します。`initWaveDrom` は `figure[data-wavedrom="pending"]` を探し、各 `data-wavedrom-spec` を `JSON.parse` して `wavedrom` を動的 import し、`WaveDrom.RenderWaveForm` で `<div class="rb-wavedrom__canvas">` に SVG を描画します。`data-wavedrom-skin` があれば対応するスキンを読み込みます。パース失敗や描画例外はその figure だけを `data-wavedrom="error"` にし、フォールバックを開きます。
113
+
114
+ ## 制限
115
+
116
+ - 描画はクライアント専用です。JavaScript が無効な環境では SVG は生成されず、WaveJSON ソースだけが残ります
117
+ - E2E のビルドは出力マークアップだけを検査します。実際の描画にはブラウザが必要です
118
+ - 本文は厳密な JSON である必要があります。WaveDrom エディタが受け付ける JSON5 形式（引用符なしキー、シングルクォート、コメント）は受理しません
119
+ - WaveJSON は HTML 属性に直接埋め込まれるため、巨大な図は避けてください
120
+ - 認識するのは `wavedrom` と `wavejson` という info string だけです。他の言語には影響しません
121
+
122
+ ## 関連資料
123
+
124
+ - [プラグインシステム](../../../docs/ja/reference/plugin-api.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@riebeckite/plugin-wavedrom",
3
- "version": "0.0.11",
3
+ "version": "0.0.13",
4
4
  "license": "Apache-2.0",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -22,7 +22,7 @@
22
22
  },
23
23
  "dependencies": {
24
24
  "wavedrom": "^3.7.0",
25
- "@riebeckite/core": "0.0.11"
25
+ "@riebeckite/core": "0.0.13"
26
26
  },
27
27
  "publishConfig": {
28
28
  "access": "public"