vitepress-plugin-field 0.1.1 → 0.3.0

package/dist/client/browser/index.js

@@ -19,7 +19,7 @@ const _hoisted_6 = {
 	key: 1,
 	class: "description"
 };
-const _sfc_main = /* @__PURE__ */ defineComponent({
+const _sfc_main = /*@__PURE__*/ defineComponent({
 	__name: "VPField",
 	props: {
 		name: {},

package/dist/client/ssr/index.js

@@ -1,7 +1,7 @@
 import { computed, defineComponent, mergeProps, useSSRContext } from "vue";
 import { ssrInterpolate, ssrRenderAttrs, ssrRenderClass, ssrRenderSlot } from "vue/server-renderer";
 //#region src/client/VPField.vue
-const _sfc_main = /* @__PURE__ */ defineComponent({
+const _sfc_main = /*@__PURE__*/ defineComponent({
 	__name: "VPField",
 	__ssrInlineRender: true,
 	props: {

package/dist/node/index.d.ts

@@ -1,91 +1,9 @@
 import { PluginSimple } from "markdown-it";
 
-//#region src/node/fieldPlugin.d.ts
-/**
- * Parsed result from a `::: field` container block.
- *
- * 字段对象 — 解析自 `::: field` 容器块的结构化结果
- */
-interface FieldObject {
-  /**
-   * Field name — defaults to `info`, overridable via `@name`
-   *
-   * 字段名称 — 默认从 `info` 中获取，可通过 `@name` 覆盖
-   */
-  name: string;
-  /**
-   * `@type` value, undefined if not set
-   *
-   * 类型注解 — 如果未设置则为 `undefined`
-   */
-  type?: string;
-  /**
-   * `@default` value, preserved as-is
-   *
-   * 默认值 — 保持原样
-   */
-  default?: string;
-  /**
-   * Whether `@required` is present
-   *
-   * 是否为必填项 — 是否在 `@required` 标签中
-   */
-  required?: boolean;
-  /**
-   * Whether `@deprecated` is present
-   *
-   * 是否为已弃用项 — 是否在 `@deprecated` 标签中
-   */
-  deprecated?: boolean;
-  /**
-   * Whether `@optional` is present
-   *
-   * 是否为可选项 — 是否在 `@optional` 标签中
-   */
-  optional?: boolean;
-  /**
-   * Description text, may span multiple lines joined by `\n`
-   *
-   * 描述文本 — 可跨多行，以 `\n` 连接
-   */
-  description?: string;
-}
-/**
- * Parse the body of a `::: field` container into a structured `FieldObject`.
- *
- * Supports a JSDoc-style tag syntax:
- * - `@name` — override the field name (derived from `info` by default)
- * - `@type` — type annotation
- * - `@default` — default value
- * - `@required` — mark as required (boolean flag)
- * - `@deprecated` — mark as deprecated (boolean flag)
- * - `@optional` — mark as optional (boolean flag)
- * - `@description` — explicit description; any non-tag line also feeds into description
- *
- * Unknown `@`-prefixed tags are treated as description text.
- * Empty lines are ignored and never interrupt a description paragraph.
- *
- * 将 `::: field` 容器的正文解析为结构化的 `FieldObject`。
- *
- * 支持类 JSDoc 的标签语法：
- * - `@name` — 覆盖字段名称（默认从 `info` 派生）
- * - `@type` — 类型注解
- * - `@default` — 默认值
- * - `@required` — 标记为必需（布尔标志）
- * - `@deprecated` — 标记为已弃用（布尔标志）
- * - `@optional` — 标记为可选（布尔标志）
- * - `@description` — 显式描述；任何非标签行也会被纳入描述
- *
- * 未知的以 `@` 开头的标签将被视为描述文本。
- * 空行会被忽略，且不会中断描述段落。
- *
- * @param content Raw text inside the `:::` container
- * @param info    Text after `::: field` on the opening line (the field name)
- */
-declare function parseFieldContent(content: string, info: string): FieldObject;
-declare const fieldMarkdownPlugin: PluginSimple;
+//#region src/node/plugin.d.ts
+declare const field: (options?: unknown) => import("vitepress-tuck").VitepressPlugin;
 //#endregion
-//#region src/node/index.d.ts
-declare const _default: (option?: unknown) => import("vitepress-tuck").VitepressPlugin;
+//#region src/node/markdown.d.ts
+declare const fieldMarkdownPlugin: PluginSimple;
 //#endregion
-export { type FieldObject, _default as default, fieldMarkdownPlugin, parseFieldContent };
+export { field as default, field, fieldMarkdownPlugin };

package/dist/node/index.js

@@ -1,7 +1,7 @@
 import { definePlugin } from "vitepress-tuck";
 import { isUndefined } from "@pengzhanbo/utils";
 import { createContainerPlugin, createContainerSyntaxPlugin, stringifyAttrs } from "vitepress-plugin-toolkit";
-//#region src/node/fieldPlugin.ts
+//#region src/node/parseFieldContent.ts
 /** Tags that carry structured meaning; everything else is description text. */
 const KNOWN_TAGS = new Set([
 	"name",
@@ -103,6 +103,8 @@ function parseFieldContent(content, info) {
 	result.description = descriptions.join("\n");
 	return result;
 }
+//#endregion
+//#region src/node/markdown.ts
 const fieldMarkdownPlugin = (md) => {
 	createContainerPlugin(md, "field-group", { before: () => "<div class=\"vp-field-group\">" });
 	createContainerSyntaxPlugin(md, "field", (tokens, idx, _, env) => {
@@ -112,8 +114,8 @@ const fieldMarkdownPlugin = (md) => {
 	});
 };
 //#endregion
-//#region src/node/index.ts
-var node_default = definePlugin(() => ({
+//#region src/node/plugin.ts
+const field = definePlugin(() => ({
 	name: "vitepress-plugin-field",
 	client: { enhance: "enhanceAppWithField" },
 	markdown: { config(md) {
@@ -121,4 +123,7 @@ var node_default = definePlugin(() => ({
 	} }
 }));
 //#endregion
-export { node_default as default, fieldMarkdownPlugin, parseFieldContent };
+//#region src/node/index.ts
+var node_default = field;
+//#endregion
+export { node_default as default, field, fieldMarkdownPlugin };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "vitepress-plugin-field",
   "type": "module",
-  "version": "0.1.1",
-  "description": "Render file tree structure in your VitePress site.",
+  "version": "0.3.0",
+  "description": "Render structured API fields and properties documentation in your VitePress site.",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
   "license": "MIT",
   "repository": {
@@ -34,11 +34,12 @@
   },
   "dependencies": {
     "@pengzhanbo/utils": "^3.7.3",
-    "vitepress-plugin-toolkit": "0.1.1",
-    "vitepress-tuck": "0.1.1"
+    "vitepress-plugin-toolkit": "0.3.0",
+    "vitepress-tuck": "0.3.0"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "scripts": {
     "clean": "rimraf --glob ./dist",