@riebeckite/plugin-hover-preview 0.0.32 → 0.0.33

package/README.md

@@ -8,9 +8,13 @@ page.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+Hover over this link to [Plugin API](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md). The preview card is fetched and rendered by this plugin; keyboard focus opens it as well.
+
 ## Overview
 
-At build time `hoverPreviewPlugin()` builds a preview index from the content
+At build time `hoverPreview()` builds a preview index from the content
 manifest (`permalink` → `{ title, excerpt, slug }`) and injects it once into
 every page that contains internal links as an inert
 `<script type="application/json" data-rb-hover-preview>` block. The client
@@ -26,15 +30,15 @@ bounded by `maxEntries` when set.
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { hoverPreviewPlugin } from "@riebeckite/plugin-hover-preview";
+import { hoverPreview } from "@riebeckite/plugin-hover-preview";
 
 export default defineConfig({
   // ...
-  plugins: [hoverPreviewPlugin()],
+  plugins: [hoverPreview()],
 });
 ```
 
-`hoverPreviewPlugin()` registers the style asset, the client entry, and the
+`hoverPreview()` registers the style asset, the client entry, and the
 build-time payload injection. `hoverPreview` is an alias of the same factory.
 
 The client entry takes no arguments. Behavior is carried by data attributes on
@@ -53,7 +57,7 @@ called without options.
 | `includeTitles` | `true`         | Whether the popover shows the target entry title.      |
 
 ```ts
-hoverPreviewPlugin({
+hoverPreview({
   delay: 200,
   excerptLength: 120,
   maxEntries: 200,
@@ -63,8 +67,8 @@ hoverPreviewPlugin({
 
 ## API
 
-- `hoverPreviewPlugin(options?)` — plugin factory
-- `hoverPreview` — alias of `hoverPreviewPlugin`
+- `hoverPreview(options?)` — plugin factory
+- `hoverPreview` — alias of `hoverPreview`
 - `resolveHoverPreviewOptions(options?)` — applies defaults and returns a
   `ResolvedHoverPreviewOptions`
 - `buildPreviewIndex(entries, options)` — builds a `HoverPreviewIndex`

package/README_ja.md

@@ -6,27 +6,31 @@
 
 [English](./README.md)
 
+## 実行例
+
+[Plugin API](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md) へのリンクにカーソルを合わせてください。プレビューカードを取得して表示するのがこのプラグインです。キーボードフォーカスでも開きます。
+
 ## 概要
 
-ビルド時に `hoverPreviewPlugin()` がコンテンツマニフェストからプレビュー索引（`permalink` → `{ title, excerpt, slug }`）を作り、内部リンクを含むページへ一度だけ `<script type="application/json" data-rb-hover-preview>` として埋め込みます。クライアント側の `initHoverPreview` がこのデータを読み、対象リンクにホバー・フォーカス・タップの処理を付けます。
+ビルド時に `hoverPreview()` がコンテンツマニフェストからプレビュー索引（`permalink` → `{ title, excerpt, slug }`）を作り、内部リンクを含むページへ一度だけ `<script type="application/json" data-rb-hover-preview>` として埋め込みます。クライアント側の `initHoverPreview` がこのデータを読み、対象リンクにホバー・フォーカス・タップの処理を付けます。
 
 抜粋は描画済み HTML からタグを除いたプレーンテキストで、空白をまとめたうえで `excerptLength` 文字に切り詰めます。内部リンクのないページには何も挿入しません。`maxEntries` を指定するとページごとのデータ量を抑えられます。
 
-## 設定する
+## 使い方
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { hoverPreviewPlugin } from "@riebeckite/plugin-hover-preview";
+import { hoverPreview } from "@riebeckite/plugin-hover-preview";
 
 export default defineConfig({
   // ...
-  plugins: [hoverPreviewPlugin()],
+  plugins: [hoverPreview()],
 });
 ```
 
-`hoverPreviewPlugin()` がスタイル、クライアントエントリ、ビルド時のデータ注入をまとめて登録します。`hoverPreview` は同じファクトリの別名です。
+`hoverPreview()` がスタイル、クライアントエントリ、ビルド時のデータ注入をまとめて登録します。`hoverPreview` は同じファクトリの別名です。
 
-クライアントエントリは引数を取りません。表示に関する設定はデータ用スクリプトの data 属性に載るため、初期化処理をオプションなしで呼んでも動作します。
+クライアントエントリは引数を取りません。表示に関する設定はデータ用スクリプトの data 属性に格納されるため、初期化処理をオプションなしで呼んでも動作します。
 
 ## オプション
 
@@ -40,7 +44,7 @@ export default defineConfig({
 | `includeTitles` | `true`         | ポップオーバーにタイトルを表示するか       |
 
 ```ts
-hoverPreviewPlugin({
+hoverPreview({
   delay: 200,
   excerptLength: 120,
   maxEntries: 200,
@@ -50,8 +54,8 @@ hoverPreviewPlugin({
 
 ## 主なエクスポート
 
-- `hoverPreviewPlugin(options?)`: プラグインを作成する
-- `hoverPreview`: `hoverPreviewPlugin` の別名
+- `hoverPreview(options?)`: プラグインを作成する
+- `hoverPreview`: `hoverPreview` の別名
 - `resolveHoverPreviewOptions(options?)`: 既定値を適用して `ResolvedHoverPreviewOptions` を返す
 - `buildPreviewIndex(entries, options)`: `HoverPreviewIndex`（`permalink` → `{ title, excerpt, slug }`）を作る
 - `htmlToPlainText(html)` / `createExcerpt(html, length)`: 抜粋を作る補助関数

package/dist/index.d.ts

@@ -4,5 +4,4 @@ export { DEFAULT_HOVER_PREVIEW_CLASS, DEFAULT_HOVER_PREVIEW_DELAY, DEFAULT_HOVER
 export { buildPreviewIndex, createExcerpt, htmlToPlainText, } from "./src/preview-index.js";
 export { HOVER_PREVIEW_ATTRIBUTE, HOVER_PREVIEW_SCRIPT_ID, hasInternalLink, renderHoverPreviewPayload, } from "./src/render.js";
 export type { HoverPreviewEntry, HoverPreviewIndex, HoverPreviewOptions, ResolvedHoverPreviewOptions, } from "./src/types.js";
-export declare function hoverPreviewPlugin(options?: HoverPreviewOptions): import("@riebeckite/core").RiebeckitePlugin<HoverPreviewOptions>;
-export declare const hoverPreview: typeof hoverPreviewPlugin;
+export declare function hoverPreview(options?: HoverPreviewOptions): import("@riebeckite/core").RiebeckitePlugin<HoverPreviewOptions>;

package/dist/index.js

@@ -305,7 +305,7 @@ function normalizeIndexSrc(value) {
 }
 
 // index.ts
-function hoverPreviewPlugin(options = {}) {
+function hoverPreview(options = {}) {
   const resolved = resolveHoverPreviewOptions(options);
   const runtime = createHoverPreviewRuntime(resolved);
   return definePlugin({
@@ -316,6 +316,7 @@ function hoverPreviewPlugin(options = {}) {
     },
     options,
     validateOptions: validateHoverPreviewOptions,
+    manifestHookCache: { version: "hover-preview-v1" },
     onManifestCreated: (context) => {
       const publicEntries = new Set(context.manifest.publicEntries);
       runtime.inject(context.manifest, (entry) => publicEntries.has(entry));
@@ -336,7 +337,6 @@ function hoverPreviewPlugin(options = {}) {
     ]
   });
 }
-var hoverPreview = hoverPreviewPlugin;
 function validateHoverPreviewOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -389,7 +389,6 @@ export {
   createExcerpt,
   hasInternalLink,
   hoverPreview,
-  hoverPreviewPlugin,
   htmlToPlainText,
   initHoverPreview,
   renderHoverPreviewPayload,

package/dist/src/preview-index.d.ts

@@ -1,6 +1,6 @@
 import type { ContentManifestEntry } from "@riebeckite/core";
 import type { HoverPreviewIndex } from "./types.js";
-export type PreviewIndexSource = {
+type PreviewIndexSource = {
     permalink: string;
     slug: string;
     title: string;
@@ -12,3 +12,4 @@ export declare function buildPreviewIndex(entries: readonly (ContentManifestEntr
 }): HoverPreviewIndex;
 export declare function createExcerpt(html: string, length: number): string;
 export declare function htmlToPlainText(html: string): string;
+export {};

package/dist/src/runtime.d.ts

@@ -1,7 +1,8 @@
 import type { ContentManifest, ContentManifestEntry, PlannedGeneratedOutput } from "@riebeckite/core";
 import type { ResolvedHoverPreviewOptions } from "./types.js";
-export type HoverPreviewRuntime = {
+type HoverPreviewRuntime = {
     plan(entries: readonly ContentManifestEntry[]): readonly PlannedGeneratedOutput[];
     inject(manifest: ContentManifest, shouldInclude?: (entry: ContentManifestEntry) => boolean): void;
 };
 export declare function createHoverPreviewRuntime(options: ResolvedHoverPreviewOptions): HoverPreviewRuntime;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-hover-preview",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,7 +21,7 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33"
   },
   "publishConfig": {
     "access": "public"
@@ -56,6 +56,7 @@
     "./style.css"
   ],
   "scripts": {
-    "build": "node ../../../scripts/build_package.mjs"
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
   }
 }