vitepress-plugin-caniuse 0.3.0 → 0.5.0

package/dist/client/browser/index.d.ts

@@ -2,16 +2,21 @@ import { EnhanceAppContext } from "vitepress/client";
 
 //#region src/client/VPCaniuse.vue.d.ts
 type __VLS_Props = {
-  feature: string;
-  past?: number;
-  future?: number;
-  meta?: string;
+  /** Feature identifier to look up on Can I Use / 要在 Can I Use 上查询的特性标识符 */feature: string; /** Number of past browser versions to display / 要显示的过去浏览器版本数量 */
+  past?: number; /** Number of future browser versions to display / 要显示的未来浏览器版本数量 */
+  future?: number; /** Unique metadata key matching iframe messages / 匹配 iframe 消息的唯一元数据键 */
+  meta?: string; /** Whether to render the Baseline view / 是否渲染 Baseline 视图 */
   baseline?: boolean;
 };
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 //#endregion
 //#region src/client/index.d.ts
+/**
+ * Enhances the VitePress application by registering the `VPCaniuse` component.
+ *
+ * 通过注册 `VPCaniuse` 组件来增强 VitePress 应用。
+ */
 declare function enhanceAppWithCaniuse({
   app
 }: EnhanceAppContext): void;

package/dist/client/browser/index.js

@@ -27,6 +27,14 @@ const _sfc_main = /*@__PURE__*/ defineComponent({
 			const { type, payload } = parseData(event.data);
 			if (type === "ciu-embed" && payload && payload.feature === __props.feature && payload.meta === __props.meta) height.value = `${Math.ceil(payload.height)}px`;
 		});
+		/**
+		* Parses incoming message data, handling both string and object payloads.
+		*
+		* 解析传入的消息数据，支持字符串和对象两种载荷格式。
+		*
+		* @param data - Raw message data from the iframe / 来自 iframe 的原始消息数据
+		* @returns Parsed message data object / 解析后的消息数据对象
+		*/
 		function parseData(data) {
 			if (typeof data === "string") try {
 				return JSON.parse(data);
@@ -46,6 +54,11 @@ const _sfc_main = /*@__PURE__*/ defineComponent({
 });
 //#endregion
 //#region src/client/index.ts
+/**
+* Enhances the VitePress application by registering the `VPCaniuse` component.
+*
+* 通过注册 `VPCaniuse` 组件来增强 VitePress 应用。
+*/
 function enhanceAppWithCaniuse({ app }) {
 	app.component("VPCaniuse", _sfc_main);
 }

package/dist/client/ssr/index.d.ts

@@ -2,16 +2,21 @@ import { EnhanceAppContext } from "vitepress/client";
 
 //#region src/client/VPCaniuse.vue.d.ts
 type __VLS_Props = {
-  feature: string;
-  past?: number;
-  future?: number;
-  meta?: string;
+  /** Feature identifier to look up on Can I Use / 要在 Can I Use 上查询的特性标识符 */feature: string; /** Number of past browser versions to display / 要显示的过去浏览器版本数量 */
+  past?: number; /** Number of future browser versions to display / 要显示的未来浏览器版本数量 */
+  future?: number; /** Unique metadata key matching iframe messages / 匹配 iframe 消息的唯一元数据键 */
+  meta?: string; /** Whether to render the Baseline view / 是否渲染 Baseline 视图 */
   baseline?: boolean;
 };
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 //#endregion
 //#region src/client/index.d.ts
+/**
+ * Enhances the VitePress application by registering the `VPCaniuse` component.
+ *
+ * 通过注册 `VPCaniuse` 组件来增强 VitePress 应用。
+ */
 declare function enhanceAppWithCaniuse({
   app
 }: EnhanceAppContext): void;

package/dist/client/ssr/index.js

@@ -27,6 +27,14 @@ const _sfc_main = /*@__PURE__*/ defineComponent({
 			const { type, payload } = parseData(event.data);
 			if (type === "ciu-embed" && payload && payload.feature === __props.feature && payload.meta === __props.meta) height.value = `${Math.ceil(payload.height)}px`;
 		});
+		/**
+		* Parses incoming message data, handling both string and object payloads.
+		*
+		* 解析传入的消息数据，支持字符串和对象两种载荷格式。
+		*
+		* @param data - Raw message data from the iframe / 来自 iframe 的原始消息数据
+		* @returns Parsed message data object / 解析后的消息数据对象
+		*/
 		function parseData(data) {
 			if (typeof data === "string") try {
 				return JSON.parse(data);
@@ -48,6 +56,11 @@ _sfc_main.setup = (props, ctx) => {
 };
 //#endregion
 //#region src/client/index.ts
+/**
+* Enhances the VitePress application by registering the `VPCaniuse` component.
+*
+* 通过注册 `VPCaniuse` 组件来增强 VitePress 应用。
+*/
 function enhanceAppWithCaniuse({ app }) {
 	app.component("VPCaniuse", _sfc_main);
 }

package/dist/node/index.d.ts

@@ -2,6 +2,17 @@ import { PluginSimple } from "markdown-it";
 
 //#region src/node/plugin.d.ts
 /**
+ * VitePress plugin for embedding Can I Use browser support information.
+ *
+ * VitePress 插件，用于嵌入 Can I Use 浏览器支持信息。
+ *
+ * The plugin registers a markdown embed rule (`@[caniuse](feature_name)`)PCaniuse`
+PCaniuse`
+ * Vue component, which renders an iframe pointing to the Can I Use embed service.
+ *
+ * 该插件注册 markdown 嵌入规则（`@[caniuse](feature_name)`）和 `VPCaniuse` Vue 组件，
+ * 组件会渲染指向 Can I Use 嵌入服务的 iframe。
+ *
  * @example
  * `.vitepress/config.ts`
  * ```ts
@@ -16,6 +27,20 @@ declare const caniuse: (options?: unknown) => import("vitepress-tuck").Vitepress
 //#endregion
 //#region src/node/markdown.d.ts
 /**
+ * markdown-it plugin that registers the `@caniuse` embed block rule.
+ *
+ * markdown-it 插件，注册 `@caniuse` 嵌入块规则。
+ *
+ * Supported syntaxes:
+ * - `@[caniuse](feature_name)` — default embed view
+ * - `@[caniuse embed{-2,4}](feature_name)` — embed with version range
+ * - `@[caniuse baseline](feature_name)` — baseline view
+ *
+ * 支持的语法：
+ * - `@[caniuse](feature_name)` — 默认嵌入视图
+ * - `@[caniuse embed{-2,4}](feature_name)` — 带版本范围的嵌入
+ * - `@[caniuse baseline](feature_name)` — Baseline 视图
+ *
  * @example
  * `.vitepress/config.ts`
  * ```ts

package/dist/node/index.js

@@ -1,7 +1,23 @@
 import { definePlugin } from "vitepress-tuck";
 import { createEmbedRuleBlock, stringifyAttrs } from "vitepress-plugin-toolkit";
 //#region src/node/markdown.ts
+const UNDERLINE_RE = /_+/g;
+let uuid = 0;
 /**
+* markdown-it plugin that registers the `@caniuse` embed block rule.
+*
+* markdown-it 插件，注册 `@caniuse` 嵌入块规则。
+*
+* Supported syntaxes:
+* - `@[caniuse](feature_name)` — default embed view
+* - `@[caniuse embed{-2,4}](feature_name)` — embed with version range
+* - `@[caniuse baseline](feature_name)` — baseline view
+*
+* 支持的语法：
+* - `@[caniuse](feature_name)` — 默认嵌入视图
+* - `@[caniuse embed{-2,4}](feature_name)` — 带版本范围的嵌入
+* - `@[caniuse baseline](feature_name)` — Baseline 视图
+*
 * @example
 * `.vitepress/config.ts`
 * ```ts
@@ -19,30 +35,51 @@ import { createEmbedRuleBlock, stringifyAttrs } from "vitepress-plugin-toolkit";
 const caniuseMarkdownPlugin = (md) => {
 	createEmbedRuleBlock(md, {
 		type: "caniuse",
-		syntaxPattern: /^@\[caniuse\s*(embed|baseline)?(?:\{([0-9,\-]*)\})?\]\(([^)]*)\)/,
-		meta: ([, mode, versions = "", feature = ""]) => ({
-			feature,
-			mode: mode || "embed",
-			versions
-		}),
-		content: resolveCanIUse
+		meta: (info, source) => {
+			const [mode, versions = ""] = info.split("{");
+			return {
+				feature: source,
+				mode: mode.trim() || "embed",
+				versions: versions.replace("}", "")
+			};
+		},
+		content: ({ feature, mode, versions }) => {
+			if (!feature) return "";
+			feature = feature.replace(UNDERLINE_RE, "_");
+			const { past, future } = resolveVersions(versions);
+			const meta = `${feature}-${uuid++}`;
+			return `<VPCaniuse${stringifyAttrs({
+				feature,
+				meta,
+				past,
+				future,
+				baseline: mode === "baseline"
+			})} />`;
+		}
 	});
 };
-const UNDERLINE_RE = /_+/g;
-let uuid = 0;
-function resolveCanIUse({ feature, mode, versions }) {
-	if (!feature) return "";
-	feature = feature.replace(UNDERLINE_RE, "_");
-	const { past, future } = resolveVersions(versions);
-	const meta = `${feature}-${uuid++}`;
-	return `<VPCaniuse${stringifyAttrs({
-		feature,
-		meta,
-		past,
-		future,
-		baseline: mode === "baseline"
-	})} />`;
-}
+/**
+* Parses a version range string into past and future browser version offsets.
+*
+* 将版本范围字符串解析为过去和未来的浏览器版本偏移量。
+*
+* The input uses comma-separated numbers where negative values represent past
+* versions and positive values represent future versions. The value `0` is
+* always included as the anchor. Values outside the range `[-5, 3]` are ignored.
+*
+* 输入使用逗号分隔的数字，负值表示过去版本，正值表示未来版本。
+* 值 `0` 始终作为锚点包含在内。超出 `[-5, 3]` 范围的值会被忽略。
+*
+* @param versions - Comma-separated version offsets (e.g. `-2,4`) / 逗号分隔的版本偏移量（例如 `-2,4`）
+* @returns An object containing the past and future version offsets / 包含过去和未来版本偏移量的对象
+*
+* @example
+* // Default values when no range is provided
+* resolveVersions('') // { past: 5, future: 3 }
+*
+* // Custom range
+* resolveVersions('-2,4') // { past: 2, future: 4 }
+*/
 function resolveVersions(versions) {
 	if (!versions) return {
 		past: 5,
@@ -59,6 +96,17 @@ function resolveVersions(versions) {
 //#endregion
 //#region src/node/plugin.ts
 /**
+* VitePress plugin for embedding Can I Use browser support information.
+*
+* VitePress 插件，用于嵌入 Can I Use 浏览器支持信息。
+*
+* The plugin registers a markdown embed rule (`@[caniuse](feature_name)`)PCaniuse`
+PCaniuse`
+* Vue component, which renders an iframe pointing to the Can I Use embed service.
+*
+* 该插件注册 markdown 嵌入规则（`@[caniuse](feature_name)`）和 `VPCaniuse` Vue 组件，
+* 组件会渲染指向 Can I Use 嵌入服务的 iframe。
+*
 * @example
 * `.vitepress/config.ts`
 * ```ts
@@ -71,7 +119,7 @@ function resolveVersions(versions) {
 */
 const caniuse = definePlugin(() => ({
 	name: "vitepress-plugin-caniuse",
-	client: { enhance: "enhanceAppWithCaniuse" },
+	componentResolver: ["VPCaniuse"],
 	markdown: { config: (md) => {
 		md.use(caniuseMarkdownPlugin);
 	} },

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "vitepress-plugin-caniuse",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Embed caniuse.com data in your VitePress site",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
   "license": "MIT",
+  "homepage": "https://tuck.pengzhanbo.cn/plugins/caniuse",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pengzhanbo/vitepress-tuck.git",
     "directory": "packages/plugin-caniuse"
   },
+  "bugs": {
+    "url": "https://github.com/pengzhanbo/vitepress-tuck/issues"
+  },
   "keywords": [
     "vitepress",
     "vitepress-plugin",
@@ -35,8 +39,8 @@
   },
   "dependencies": {
     "@vueuse/core": "^14.3.0",
-    "vitepress-tuck": "0.3.0",
-    "vitepress-plugin-toolkit": "0.3.0"
+    "vitepress-plugin-toolkit": "0.5.0",
+    "vitepress-tuck": "0.5.0"
   },
   "publishConfig": {
     "access": "public",