@riebeckite/plugin-code-annotations 0.0.32 → 0.0.33

package/README.md

@@ -44,6 +44,16 @@ An empty, malformed, or missing target language leaves the fence as an ordinary
 `diff` code block. A target language that the syntax highlighter does not know
 falls back to its normal unhighlighted rendering and does not fail the build.
 
+## Live example
+
+A `diff` fence with a target language renders additions and removals with the normal code block UI.
+
+~~~diff js
+const kept = true;
++ const added = "new line";
+- const removed = false;
+~~~
+
 ## Integration
 
 The plugin transforms Markdown in its remark phase, records each line marker in
@@ -54,7 +64,7 @@ not import it, so the two packages remain independently configurable.
 
 ## Exports
 
-- `codeAnnotations()` / `codeAnnotationsPlugin()` — plugin factory
+- `codeAnnotations()` / `codeAnnotations()` — plugin factory
 - `remarkCodeAnnotations()` — Markdown transform
 - `rehypeCodeAnnotations()` — HTML transform
 - `collectCodeDiff(code)` — separates diff markers from source text

package/README_ja.md

@@ -2,7 +2,7 @@
 
 <!-- Generated from docs/docs/plugins/code-annotations.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-差分のコードブロックを、対象言語のシンタックスハイライトとRiebeckiteのコードブロックUIで表示します。
+コードの差分を、対象言語のシンタックスハイライトと Riebeckite のコードブロック UI で表示するプラグインです。
 
 [English](./README.md)
 
@@ -33,23 +33,33 @@ const unchanged = true;
 ```
 ````
 
-`+` と `-` はコード本体とは別に描画されます。そのためJavaScript、TypeScript、Python、JSON
+`+` と `-` はコード本体とは別に描画されます。そのため JavaScript、TypeScript、Python、JSON
 などのシンタックスハイライトを妨げません。コピー操作では、表示された差分と同じくマーカーも含めてコピーします。
 
 対象言語が空、形式が不正、または指定されていないフェンスは、通常の `diff` コードブロックとして扱います。
 シンタックスハイライトが対応していない言語を指定しても、ハイライトなしで表示され、ビルドは失敗しません。
 
+## 実行例
+
+対象言語を指定した `diff` フェンスは、通常のコードブロック UI のまま追加行と削除行を表示します。
+
+~~~diff js
+const kept = true;
++ const added = "new line";
+- const removed = false;
+~~~
+
 ## 連携
 
-このプラグインはremark段階で差分マーカーをコード本体から分離し、フェンスメタ情報に記録します。rehype段階では、
-マーカーと既存の `rr-code__line--add` / `rr-code__line--remove` クラスを戻します。行ラッパーやコードブロックUIは
-`code-enhance` が提供します。両パッケージはimportで依存していないため、個別に設定できます。
+このプラグインは remark 段階で差分マーカーをコード本体から分離し、フェンスのメタ情報に記録します。rehype 段階では、
+マーカーと既存の `rr-code__line--add` / `rr-code__line--remove` クラスを戻します。行ラッパーやコードブロック UI は
+`code-enhance` が提供します。両パッケージは相互に import していないため、個別に設定できます。
 
-## 公開API
+## 公開 API
 
-- `codeAnnotations()` / `codeAnnotationsPlugin()`：プラグインファクトリ
-- `remarkCodeAnnotations()`：Markdown変換
-- `rehypeCodeAnnotations()`：HTML変換
+- `codeAnnotations()` / `codeAnnotations()`：プラグインファクトリ
+- `remarkCodeAnnotations()`：Markdown 変換
+- `rehypeCodeAnnotations()`：HTML 変換
 - `collectCodeDiff(code)`：差分マーカーとコード本体を分離
 - `serializeCodeDiff(plan)` / `deserializeCodeDiff(value)`：行情報の変換
 - `encodeCodeDiffMeta(plan)` / `extractCodeDiffMeta(meta)`：メタ情報の変換

package/dist/index.d.ts

@@ -3,4 +3,3 @@ export { appendCodeDiffMeta, collectCodeDiff, deserializeCodeDiff, encodeCodeDif
 export { rehypeCodeAnnotations } from "./src/rehype.js";
 export { remarkCodeAnnotations } from "./src/remark.js";
 export declare function codeAnnotations(): import("@riebeckite/core").RiebeckitePlugin<unknown>;
-export declare const codeAnnotationsPlugin: typeof codeAnnotations;

package/dist/index.js

@@ -249,11 +249,9 @@ function codeAnnotations() {
     }
   });
 }
-var codeAnnotationsPlugin = codeAnnotations;
 export {
   appendCodeDiffMeta,
   codeAnnotations,
-  codeAnnotationsPlugin,
   collectCodeDiff,
   deserializeCodeDiff,
   encodeCodeDiffMeta,

package/dist/src/annotations.d.ts

@@ -1,4 +1,3 @@
-export declare const DIFF_META_PREFIX = "rb-diff=";
 export type DiffMarker = "+" | "-" | null;
 export type CodeDiffPlan = {
     markers: DiffMarker[];

package/dist/src/hast.d.ts

@@ -5,7 +5,5 @@ export declare function element(tagName: string, properties?: Record<string, unk
 export declare function visitElementTree(node: HastNode, visitor: (node: ElementNode, ancestors: ElementNode[]) => void, ancestors?: ElementNode[]): void;
 export declare function getStringProperty(node: ElementNode, key: string): string | null;
 export declare function getBooleanProperty(node: ElementNode, key: string): boolean;
-export declare function hasProperty(node: ElementNode, key: string): boolean;
 export declare function mergeClassName(current: unknown, next: string): string;
 export declare function getDataMeta(node: ElementNode | null | undefined): string | null;
-export declare function getTextContent(node: HastNode): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-code-annotations",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,11 +14,11 @@
     }
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.32"
+    "@riebeckite/test": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"