@riebeckite/plugin-wavedrom 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,124 @@
+# @riebeckite/plugin-wavedrom
+
+Renders ` ```wavedrom ` code blocks as [WaveDrom](https://wavedrom.com/) timing diagrams.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`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`.
+
+## Configuration
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { wavedrom } from "@riebeckite/plugin-wavedrom";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    wavedrom({
+      skin: "default",
+      caption: true,
+    }),
+  ],
+});
+```
+
+## Writing a diagram
+
+The block body is a **strict JSON** WaveJSON object. Keys must be double-quoted, and trailing commas or comments are not allowed.
+
+````markdown
+```wavedrom
+{
+  "signal": [
+    { "name": "clk", "wave": "p......" },
+    { "name": "bus", "wave": "x.34.5x", "data": "head body tail" },
+    { "name": "wire", "wave": "0.1..0." }
+  ]
+}
+```
+````
+
+Top-level keys other than `signal`, `assign`, and `reg` — such as WaveDrom's `head`, `config`, and `foot` — are passed through unchanged.
+
+```wavedrom
+{
+  "head": { "text": "handshake" },
+  "signal": [
+    { "name": "req", "wave": "01..0" },
+    { "name": "ack", "wave": "0.1.0" }
+  ]
+}
+```
+
+### Captions
+
+A caption is taken from the code block's `title`.
+
+````markdown
+```wavedrom title="Read cycle"
+{ "signal": [{ "name": "clk", "wave": "p..." }] }
+```
+````
+
+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.
+
+````markdown
+```wavedrom
+{
+  "caption": "Read cycle",
+  "signal": [{ "name": "clk", "wave": "p..." }]
+}
+```
+````
+
+## Output
+
+```html
+<figure class="rb-wavedrom" data-wavedrom="pending" data-wavedrom-spec="{&quot;signal&quot;:[...]}" data-wavedrom-skin="default">
+  <figcaption id="rb-wavedrom-xxxx-caption" class="rb-wavedrom__caption">Read cycle</figcaption>
+  <div class="rb-wavedrom__canvas" data-wavedrom-canvas="true" role="img" aria-labelledby="rb-wavedrom-xxxx-caption"></div>
+  <details class="rb-wavedrom__fallback">
+    <summary>WaveJSON source</summary>
+    <pre><code>{ ... }</code></pre>
+  </details>
+</figure>
+```
+
+- `.rb-wavedrom` — the figure wrapper; inherits `--rb-color-*` for theming
+- `.rb-wavedrom__canvas` — where WaveDrom draws the SVG; marked with `data-wavedrom-canvas="true"`
+- `.rb-wavedrom__caption` — the `<figcaption>` when a caption is present
+- `.rb-wavedrom__fallback` — a `<details>` holding the WaveJSON source
+
+The `data-wavedrom` attribute reports render state: `pending` initially, `rendered` on success, and `error` on failure. On failure the fallback `<details>` is opened.
+
+## Options
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| `skin` | `"default" \| "narrow" \| "lowkey"` | `"default"` | WaveDrom skin used by the browser renderer |
+| `caption` | `boolean` | `true` | Render the extracted caption as a `<figcaption>` |
+| `fallback` | `boolean` | `true` | Render the WaveJSON source in a `<details>` block |
+| `className` | `string` | `"rb-wavedrom"` | Base class applied to the figure |
+
+## Diagnostics
+
+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"`.
+
+## Client rendering
+
+`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.
+
+## Limitations
+
+- Rendering is client-only. Without JavaScript the SVG is never produced and only the WaveJSON source remains
+- The E2E build checks the emitted markup only; actual rendering requires a browser
+- The body must be strict JSON. The JSON5 form accepted by the WaveDrom editor (unquoted keys, single quotes, comments) is not supported
+- The WaveJSON is embedded directly in an HTML attribute, so keep diagrams reasonably small
+- Only the `wavedrom` and `wavejson` info strings are recognized; other languages are unaffected
+
+## See also
+
+- [Plugin system](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -0,0 +1,124 @@
+# @riebeckite/plugin-wavedrom
+
+` ```wavedrom ` コードブロックを [WaveDrom](https://wavedrom.com/) のタイミング図として表示するプラグインです。
+
+[English](./README.md)
+
+## 概要
+
+`wavedrom()` は ` ```wavedrom `（および ` ```wavejson `）のコードブロックを `<figure>` に置き換え、正規化した WaveJSON を `data-wavedrom-spec` 属性に埋め込みます。図そのものはブラウザ側の `initWaveDrom` が `wavedrom` を動的 import して描画します。ビルドはマークアップだけを出力します。実行順は `order: -10` です。
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { wavedrom } from "@riebeckite/plugin-wavedrom";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    wavedrom({
+      skin: "default",
+      caption: true,
+    }),
+  ],
+});
+```
+
+## タイミング図を書く
+
+本文は **厳密な JSON** の WaveJSON オブジェクトです。キーは必ず二重引用符で囲み、末尾のカンマやコメントは書けません。
+
+````markdown
+```wavedrom
+{
+  "signal": [
+    { "name": "clk", "wave": "p......" },
+    { "name": "bus", "wave": "x.34.5x", "data": "head body tail" },
+    { "name": "wire", "wave": "0.1..0." }
+  ]
+}
+```
+````
+
+WaveDrom の `head` / `config` / `foot` など、`signal`・`assign`・`reg` 以外のトップレベルキーもそのまま引き継がれます。
+
+```wavedrom
+{
+  "head": { "text": "handshake" },
+  "signal": [
+    { "name": "req", "wave": "01..0" },
+    { "name": "ack", "wave": "0.1.0" }
+  ]
+}
+```
+
+### キャプション
+
+キャプションはコードブロックの `title` から取得します。
+
+````markdown
+```wavedrom title="読み出しサイクル"
+{ "signal": [{ "name": "clk", "wave": "p..." }] }
+```
+````
+
+JSON のトップレベル `"caption"` キーでも指定できます。このキーは図を描画する前に取り除かれるため、WaveDrom には渡りません。
+
+````markdown
+```wavedrom
+{
+  "caption": "読み出しサイクル",
+  "signal": [{ "name": "clk", "wave": "p..." }]
+}
+```
+````
+
+## 出力
+
+```html
+<figure class="rb-wavedrom" data-wavedrom="pending" data-wavedrom-spec="{&quot;signal&quot;:[...]}" data-wavedrom-skin="default">
+  <figcaption id="rb-wavedrom-xxxx-caption" class="rb-wavedrom__caption">読み出しサイクル</figcaption>
+  <div class="rb-wavedrom__canvas" data-wavedrom-canvas="true" role="img" aria-labelledby="rb-wavedrom-xxxx-caption"></div>
+  <details class="rb-wavedrom__fallback">
+    <summary>WaveJSON source</summary>
+    <pre><code>{ ... }</code></pre>
+  </details>
+</figure>
+```
+
+- `.rb-wavedrom` — 図全体のラッパー。`--rb-color-*` で配色を引き継ぎます
+- `.rb-wavedrom__canvas` — WaveDrom が SVG を描画する領域。`data-wavedrom-canvas="true"`
+- `.rb-wavedrom__caption` — キャプションがある場合の `<figcaption>`
+- `.rb-wavedrom__fallback` — WaveJSON のソースを表示する `<details>`
+
+`data-wavedrom` 属性は描画状態を表します。初期値は `pending`、成功時は `rendered`、失敗時は `error` になります。失敗時はフォールバックの `<details>` が開きます。
+
+## オプション
+
+| 項目 | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `skin` | `"default" \| "narrow" \| "lowkey"` | `"default"` | ブラウザ側で使う WaveDrom スキン |
+| `caption` | `boolean` | `true` | キャプションを `<figcaption>` として表示する |
+| `fallback` | `boolean` | `true` | WaveJSON ソースを `<details>` に表示する |
+| `className` | `string` | `"rb-wavedrom"` | figure に付ける基底クラス |
+
+## 診断
+
+本文が JSON として不正、オブジェクトでない、`signal` / `assign` / `reg` がない場合は、元のコードブロックをそのまま残し、`source: "@riebeckite/plugin-wavedrom"`、`ruleId: "invalid-config"` の診断を出します。
+
+## クライアント側の描画
+
+`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"` にし、フォールバックを開きます。
+
+## 制限
+
+- 描画はクライアント専用です。JavaScript が無効な環境では SVG は生成されず、WaveJSON ソースだけが残ります
+- E2E のビルドは出力マークアップだけを検査します。実際の描画にはブラウザが必要です
+- 本文は厳密な JSON である必要があります。WaveDrom エディタが受け付ける JSON5 形式（引用符なしキー、シングルクォート、コメント）は受理しません
+- WaveJSON は HTML 属性に直接埋め込まれるため、巨大な図は避けてください
+- 認識するのは `wavedrom` と `wavejson` という info string だけです。他の言語には影響しません
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)

package/dist/client.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Draws every server-rendered WaveDrom figure with the `wavedrom` package.
+ *
+ * The `wavedrom` library is imported lazily so sites that never render a
+ * timing diagram do not ship it. Figures carry their normalized WaveJSON in
+ * `data-wavedrom-spec`; the requested skin (a build-time option) travels in
+ * `data-wavedrom-skin` because client entry code cannot see plugin options.
+ */
+export declare function initWaveDrom(): Promise<void>;

package/dist/client.js

@@ -0,0 +1,74 @@
+// client.ts
+var PENDING_SELECTOR = '[data-wavedrom="pending"]';
+var CANVAS_ATTRIBUTE = "data-wavedrom-canvas";
+var CANVAS_ID_PREFIX = "rb-wavedrom-canvas-";
+var SKINS = ["default", "narrow", "lowkey"];
+var renderCounter = 0;
+async function initWaveDrom() {
+  const figures = Array.from(
+    document.querySelectorAll(PENDING_SELECTOR)
+  );
+  if (figures.length === 0) return;
+  let api;
+  try {
+    api = await loadWavedrom();
+  } catch {
+    revealFallbacks(figures);
+    return;
+  }
+  let notFirstSignal = false;
+  for (const figure of figures) {
+    const canvas = figure.querySelector(`[${CANVAS_ATTRIBUTE}]`);
+    const serialized = figure.dataset.wavedromSpec;
+    if (!canvas || !serialized) {
+      setError(figure);
+      continue;
+    }
+    let spec;
+    try {
+      spec = JSON.parse(serialized);
+    } catch {
+      setError(figure);
+      continue;
+    }
+    try {
+      const skin = await loadSkin(figure.dataset.wavedromSkin, api);
+      renderFigure(api, spec, canvas, skin, notFirstSignal);
+      figure.dataset.wavedrom = "rendered";
+      if (spec.signal) notFirstSignal = true;
+    } catch {
+      setError(figure);
+    }
+  }
+}
+function renderFigure(api, spec, canvas, skin, notFirstSignal) {
+  const index = renderCounter++;
+  canvas.id = `${CANVAS_ID_PREFIX}${index}`;
+  window.WaveSkin = skin ?? api.waveSkin;
+  api.renderWaveForm(index, spec, CANVAS_ID_PREFIX, notFirstSignal);
+}
+async function loadWavedrom() {
+  const mod = await import("wavedrom");
+  return mod.default ?? mod;
+}
+async function loadSkin(name, api) {
+  const skin = name ?? "default";
+  if (!SKINS.includes(skin) || skin === "default") return api.waveSkin;
+  try {
+    const mod = await (skin === "narrow" ? import("wavedrom/skins/narrow") : import("wavedrom/skins/lowkey"));
+    return mod[skin] ?? mod.default?.[skin] ?? api.waveSkin;
+  } catch {
+    return api.waveSkin;
+  }
+}
+function revealFallbacks(figures) {
+  for (const figure of figures) setError(figure);
+}
+function setError(figure) {
+  figure.dataset.wavedrom = "error";
+  const details = figure.querySelector("details");
+  if (details) details.open = true;
+}
+export {
+  initWaveDrom
+};

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import type { WavedromOptions } from "./src/types.js";
+export { rehypeWavedrom } from "./src/rehype.js";
+export type { WavedromOptions, WavedromSkin } from "./src/types.js";
+/**
+ * Renders fenced `wavedrom` (and `wavejson`) code blocks as WaveDrom timing
+ * diagrams. The block body is a strict JSON WaveJSON object; the diagram is
+ * drawn in the browser by `initWaveDrom`.
+ */
+export declare function wavedrom(options?: WavedromOptions): import("@riebeckite/core").RiebeckitePlugin<WavedromOptions>;
+/** Alias kept for symmetry with the other plugin factories. */
+export declare const wavedromPlugin: typeof wavedrom;

package/dist/index.js

@@ -0,0 +1,244 @@
+// index.ts
+import {
+  createClientEntry,
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/hast.ts
+function visitElements(node, visitor, parent, index) {
+  if (isElementNode(node)) visitor(node, parent, index);
+  for (const [childIndex, child] of [...getChildren(node)].entries()) {
+    visitElements(
+      child,
+      visitor,
+      hasChildren(node) ? node : parent,
+      childIndex
+    );
+  }
+}
+function element(tagName, properties = {}, children = []) {
+  return { type: "element", tagName, properties, children };
+}
+function text(value) {
+  return { type: "text", value };
+}
+function getTextContent(node) {
+  if (node.type === "text" && "value" in node && typeof node.value === "string") {
+    return node.value;
+  }
+  return getChildren(node).map(getTextContent).join("");
+}
+function getStringProperty(node, key) {
+  const value = node.properties?.[key];
+  if (typeof value === "string") return value;
+  if (Array.isArray(value)) return value.join(" ");
+  return null;
+}
+function hasClass(node, className) {
+  const value = node.properties?.className;
+  const classes = Array.isArray(value) ? value.map(String) : typeof value === "string" ? value.split(/\s+/) : [];
+  return classes.includes(className);
+}
+function isElementNode(node) {
+  return node.type === "element";
+}
+function hasChildren(node) {
+  return Array.isArray(node.children);
+}
+function getChildren(node) {
+  const children = node.children;
+  return Array.isArray(children) ? children : [];
+}
+
+// src/rehype.ts
+var DEFAULT_CLASS_NAME = "rb-wavedrom";
+var DEFAULT_SKIN = "default";
+var WAVEDROM_LANGUAGE_CLASSES = ["language-wavedrom", "language-wavejson"];
+function rehypeWavedrom(options = {}) {
+  const className = options.className?.trim() || DEFAULT_CLASS_NAME;
+  const skin = options.skin ?? DEFAULT_SKIN;
+  const caption = options.caption !== false;
+  const fallback = options.fallback !== false;
+  return (tree, file) => {
+    visitElements(tree, (node, parent, index) => {
+      if (!parent || index === void 0 || !isWavedromCodeBlock(node)) return;
+      replaceWavedromBlock(parent, index, node, file, {
+        className,
+        skin,
+        caption,
+        fallback
+      });
+    });
+  };
+}
+function replaceWavedromBlock(parent, index, pre, file, options) {
+  const code = findDirectChild(pre, "code");
+  const source = code ? getTextContent(code).trim() : getTextContent(pre).trim();
+  const parsed = parseSpec(source);
+  if (isParseFailure(parsed)) {
+    reportDiagnostic(file, parsed.message);
+    return;
+  }
+  const captionText = options.caption ? extractCaption(pre, code, parsed.caption) ?? null : null;
+  parent.children = parent.children ?? [];
+  parent.children[index] = buildFigure({
+    className: options.className,
+    skin: options.skin,
+    source,
+    spec: parsed.spec,
+    caption: captionText,
+    fallback: options.fallback
+  });
+}
+function buildFigure(input) {
+  const base = input.className;
+  const labelId = `${base}-${hashSource(input.source)}-caption`;
+  const serialized = JSON.stringify(input.spec);
+  const children = [];
+  if (input.caption) {
+    children.push(
+      element("figcaption", { id: labelId, className: `${base}__caption` }, [
+        text(input.caption)
+      ])
+    );
+  }
+  children.push(
+    element(
+      "div",
+      {
+        className: `${base}__canvas`,
+        dataWavedromCanvas: "true",
+        role: "img",
+        ariaLabelledby: input.caption ? labelId : void 0,
+        ariaLabel: input.caption ? void 0 : "WaveDrom timing diagram"
+      },
+      []
+    )
+  );
+  if (input.fallback) {
+    children.push(
+      element("details", { className: `${base}__fallback` }, [
+        element("summary", {}, [text("WaveJSON source")]),
+        element("pre", {}, [element("code", {}, [text(input.source)])])
+      ])
+    );
+  }
+  return element(
+    "figure",
+    {
+      className: base,
+      dataWavedrom: "pending",
+      dataWavedromSpec: serialized,
+      dataWavedromSkin: input.skin
+    },
+    children
+  );
+}
+function isParseFailure(result) {
+  return result.ok === false;
+}
+function parseSpec(source) {
+  let parsed;
+  try {
+    parsed = JSON.parse(source);
+  } catch (error) {
+    return { ok: false, message: `Invalid JSON: ${formatError(error)}` };
+  }
+  if (!isRecord(parsed)) {
+    return { ok: false, message: "Expected a JSON object." };
+  }
+  const { caption, ...spec } = parsed;
+  if (!hasWaveDromBody(spec)) {
+    return {
+      ok: false,
+      message: 'Expected a WaveJSON object with a "signal", "assign", or "reg" property.'
+    };
+  }
+  const captionText = typeof caption === "string" && caption.trim() !== "" ? caption.trim() : null;
+  return { ok: true, spec, caption: captionText };
+}
+function hasWaveDromBody(spec) {
+  return Array.isArray(spec.signal) || Array.isArray(spec.assign) || "reg" in spec;
+}
+function extractCaption(pre, code, fromSpec) {
+  const title = getStringProperty(pre, "title") ?? (code ? getStringProperty(code, "title") : null);
+  const value = title ?? fromSpec;
+  return value?.trim() || void 0;
+}
+function isWavedromCodeBlock(node) {
+  if (node.tagName !== "pre") return false;
+  const code = findDirectChild(node, "code");
+  return Boolean(
+    code && WAVEDROM_LANGUAGE_CLASSES.some((className) => hasClass(code, className))
+  );
+}
+function findDirectChild(node, tagName) {
+  return node.children?.find(
+    (child) => child.type === "element" && child.tagName === tagName
+  ) ?? null;
+}
+function reportDiagnostic(file, message) {
+  const reporter = file?.message;
+  if (typeof reporter !== "function") return;
+  const diagnostic = reporter.call(file, `Invalid WaveDrom config: ${message}`);
+  if (diagnostic && typeof diagnostic === "object") {
+    Object.assign(diagnostic, {
+      source: "@riebeckite/plugin-wavedrom",
+      ruleId: "invalid-config"
+    });
+  }
+}
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function hashSource(source) {
+  let hash = 0;
+  for (const char of source) hash = hash * 31 + char.charCodeAt(0) | 0;
+  return Math.abs(hash).toString(36);
+}
+function formatError(error) {
+  return error instanceof Error ? error.message : String(error);
+}
+
+// index.ts
+var SKINS = ["default", "narrow", "lowkey"];
+function wavedrom(options = {}) {
+  return definePlugin({
+    name: "wavedrom",
+    order: -10,
+    options,
+    validateOptions: validateWavedromOptions,
+    extendHtmlPipeline: (pipeline) => {
+      pipeline.use(rehypeWavedrom, options);
+    },
+    assets: [createStyleAsset("wavedrom")],
+    clientEntries: [createClientEntry("wavedrom", "initWaveDrom")]
+  });
+}
+var wavedromPlugin = wavedrom;
+function validateWavedromOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  if (options.skin !== void 0 && !SKINS.includes(options.skin)) {
+    issues.push({
+      path: "skin",
+      message: 'Expected "default", "narrow", or "lowkey".'
+    });
+  }
+  if (options.caption !== void 0 && typeof options.caption !== "boolean") {
+    issues.push({ path: "caption", message: "Expected a boolean." });
+  }
+  if (options.fallback !== void 0 && typeof options.fallback !== "boolean") {
+    issues.push({ path: "fallback", message: "Expected a boolean." });
+  }
+  if (options.className !== void 0 && (typeof options.className !== "string" || options.className.trim() === "")) {
+    issues.push({ path: "className", message: "Expected a non-empty string." });
+  }
+  return issues;
+}
+export {
+  rehypeWavedrom,
+  wavedrom,
+  wavedromPlugin
+};

package/dist/src/hast.d.ts

@@ -0,0 +1,8 @@
+import type { ElementNode, HastNode, ParentNode, TextNode } from "./types.js";
+export declare function visitElements(node: HastNode, visitor: (node: ElementNode, parent?: ParentNode, index?: number) => void, parent?: ParentNode, index?: number): void;
+export declare function element(tagName: string, properties?: Record<string, unknown>, children?: HastNode[]): ElementNode;
+export declare function text(value: string): TextNode;
+export declare function getTextContent(node: HastNode): string;
+export declare function getStringProperty(node: ElementNode, key: string): string | null;
+export declare function hasClass(node: ElementNode, className: string): boolean;
+export declare function mergeClassName(current: unknown, next: string): string;

package/dist/src/rehype.d.ts

@@ -0,0 +1,7 @@
+import type { HastNode, WavedromOptions } from "./types.js";
+/**
+ * Replaces every `wavedrom` (or `wavejson`) fenced code block with a figure
+ * that carries the normalized WaveJSON in a data attribute. The diagram itself
+ * is drawn in the browser by `initWaveDrom`.
+ */
+export declare function rehypeWavedrom(options?: WavedromOptions): (tree: HastNode, file: unknown) => void;

package/dist/src/types.d.ts

@@ -0,0 +1,37 @@
+export type ElementNode = {
+    type: string;
+    tagName?: string;
+    properties?: Record<string, unknown>;
+    children?: HastNode[];
+};
+export type ParentNode = HastNode & {
+    children?: HastNode[];
+};
+export type TextNode = {
+    type: "text";
+    value: string;
+};
+export type RawNode = {
+    type: "raw";
+    value: string;
+};
+export type HastNode = ElementNode | TextNode | RawNode | {
+    type: string;
+    [key: string]: unknown;
+};
+/** A WaveDrom skin shipped by the `wavedrom` package. */
+export type WavedromSkin = "default" | "narrow" | "lowkey";
+export type WavedromOptions = {
+    /**
+     * WaveDrom skin used by the browser renderer. The value is forwarded to the
+     * client through a `data-wavedrom-skin` attribute because client entry code
+     * cannot see plugin options. Defaults to `"default"`.
+     */
+    skin?: WavedromSkin;
+    /** Render the extracted caption as a `<figcaption>`. Defaults to `true`. */
+    caption?: boolean;
+    /** Render a `<details>` block containing the WaveJSON source. Defaults to `true`. */
+    fallback?: boolean;
+    /** Base CSS class for the generated figure. Defaults to `"rb-wavedrom"`. */
+    className?: string;
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@riebeckite/plugin-wavedrom",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js",
+      "source": "./client.ts",
+      "default": "./dist/client.js"
+    },
+    "./style.css": "./style.css"
+  },
+  "dependencies": {
+    "wavedrom": "^3.7.0",
+    "@riebeckite/core": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist",
+    "style.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/wavedrom"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "WaveDrom timing diagram rendering for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "wavedrom",
+    "diagrams"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/style.css

@@ -0,0 +1,67 @@
+.rb-wavedrom {
+  --rb-wavedrom-paper: var(--rb-color-paper, #ffffff);
+  --rb-wavedrom-ink: var(--rb-color-ink, #000000);
+  --rb-wavedrom-muted: var(--rb-color-muted, #69645c);
+  --rb-wavedrom-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rb-wavedrom-ink) 18%, transparent)
+  );
+  margin: 2rem 0;
+  border: 1px solid var(--rb-wavedrom-rule);
+  background: color-mix(
+    in srgb,
+    var(--rb-wavedrom-paper) 96%,
+    var(--rb-wavedrom-ink)
+  );
+  color: var(--rb-wavedrom-ink);
+}
+
+.rb-wavedrom__caption {
+  padding: 0.625rem 0.75rem;
+  border-bottom: 1px solid var(--rb-wavedrom-rule);
+  color: var(--rb-wavedrom-muted);
+  font-size: 0.875rem;
+}
+
+.rb-wavedrom__canvas {
+  overflow: auto;
+  padding: 1rem;
+}
+
+.rb-wavedrom__canvas > svg {
+  display: block;
+  max-width: 100%;
+  height: auto;
+}
+
+.rb-wavedrom__fallback {
+  border-top: 1px solid var(--rb-wavedrom-rule);
+  color: var(--rb-wavedrom-muted);
+  font-size: 0.8125rem;
+}
+
+.rb-wavedrom__fallback summary {
+  cursor: pointer;
+  padding: 0.5rem 0.75rem;
+}
+
+.rb-wavedrom__fallback pre {
+  overflow: auto;
+  margin: 0 1rem;
+  padding: 0.75rem;
+  border-top: 1px solid var(--rb-wavedrom-rule);
+  color: var(--rb-wavedrom-ink);
+  background: color-mix(in srgb, var(--rb-wavedrom-ink) 6%, transparent);
+}
+
+.rb-wavedrom[data-wavedrom="pending"] .rb-wavedrom__canvas:empty::before,
+.rb-wavedrom[data-wavedrom="error"] .rb-wavedrom__canvas:empty::before {
+  content: "Timing diagram could not be rendered.";
+  color: var(--rb-wavedrom-muted);
+}
+
+html[data-theme="dark"] .rb-wavedrom,
+html.dark .rb-wavedrom {
+  --rb-wavedrom-paper: var(--rb-color-ink, #000000);
+  --rb-wavedrom-ink: var(--rb-color-paper, #ffffff);
+}