vitepress-plugin-file-tree 0.9.0 → 0.11.0

package/dist/client/browser/index.js

@@ -1,13 +1,13 @@
 import "../style.css";
 import { computed, createBlock, createCommentVNode, createElementBlock, createElementVNode, defineComponent, inject, mergeProps, normalizeClass, openBlock, ref, renderSlot, toDisplayString, unref, vShow, withDirectives } from "vue";
 import { VPCopyButton } from "vitepress-plugin-toolkit/client";
-//#region src/client/VPFileTree.vue
+
 const _hoisted_1$1 = {
 	key: 0,
 	class: "vp-file-tree-title"
 };
 const _hoisted_2$1 = { class: "file-tree-content" };
-const _sfc_main = /*@__PURE__*/ defineComponent({
+const _sfc_main =  defineComponent({
 	__name: "VPFileTree",
 	props: {
 		title: {},
@@ -27,22 +27,14 @@ const _sfc_main = /*@__PURE__*/ defineComponent({
 		};
 	}
 });
-//#endregion
-//#region src/client/constants.ts
-/**
-* File tree node click event
-*
-* 文件树节点点击事件
-*/
+
+
+
 const ON_NODE_CLICK = Symbol(import.meta.env.DEV ? "on-file-tree-node-click" : "");
-/**
-* Active file tree node
-*
-* 当前激活的文件树节点
-*/
+
 const ACTIVE_NODE_KEY = Symbol(import.meta.env.DEV ? "active-file-tree-node" : "");
-//#endregion
-//#region src/client/VPFileTreeNode.vue
+
+
 const _hoisted_1 = { class: "vp-file-tree-node" };
 const _hoisted_2 = ["data-filename"];
 const _hoisted_3 = {
@@ -53,7 +45,7 @@ const _hoisted_4 = {
 	key: 0,
 	class: "group"
 };
-const _sfc_main$1 = /*@__PURE__*/ defineComponent({
+const _sfc_main$1 =  defineComponent({
 	__name: "VPFileTreeNode",
 	props: {
 		type: {},
@@ -68,30 +60,12 @@ const _sfc_main$1 = /*@__PURE__*/ defineComponent({
 		const activeFileTreeNode = inject(ACTIVE_NODE_KEY, ref(""));
 		const onNodeClick = inject(ON_NODE_CLICK, () => {});
 		const active = ref(__props.expanded);
-		/**
-		* Notify the parent of a node click event via the injected callback.
-		*
-		* 通过注入的回调通知父组件节点点击事件。
-		*
-		* Ellipsis placeholders (`…` or `...`) are ignored to avoid triggering
-		* selection on empty folder markers.
-		*/
+		
 		function nodeClick() {
 			if (__props.filename === "…" || __props.filename === "...") return;
 			onNodeClick(__props.filepath || __props.filename, __props.type);
 		}
-		/**
-		* Handle click events on the node, toggling folder expansion or firing
-		* the node click callback for files.
-		*
-		* 处理节点的点击事件，切换文件夹展开状态或触发文件节点的点击回调。
-		*
-		* For folders, clicks on the comment area are ignored so that inline
-		* comments remain interactive. For files, the click callback fires
-		* directly.
-		*
-		* @param ev - Native mouse event / 原生鼠标事件
-		*/
+		
 		function toggle(ev) {
 			if (__props.type === "folder") {
 				if (!ev.target.matches(".comment, .comment *")) {
@@ -127,24 +101,12 @@ const _sfc_main$1 = /*@__PURE__*/ defineComponent({
 		};
 	}
 });
-//#endregion
-//#region src/client/index.ts
-/**
-* Register file tree components globally during VitePress app enhancement.
-*
-* 在 VitePress 应用增强阶段全局注册文件树组件。
-*
-* Called automatically by the `virtual:enhance-app` module when the plugin
-* is loaded via `vitepress-tuck`'s `defineConfig`. Registers `VPFileTree`
-* and `VPFileTreeNode` as global Vue components so they can be used in
-* markdown-rendered HTML without explicit imports.
-*
-* @param ctx - VitePress enhance app context / VitePress 应用增强上下文
-* @param ctx.app - The VitePress Vue app instance / VitePress 的 Vue 应用实例
-*/
+
+
+
 function enhanceAppWithFileTree({ app }) {
 	if (!app._context.components.VPFileTree) app.component("VPFileTree", _sfc_main);
 	if (!app._context.components.VPFileTreeNode) app.component("VPFileTreeNode", _sfc_main$1);
 }
-//#endregion
+
 export { ACTIVE_NODE_KEY, ON_NODE_CLICK, _sfc_main as VPFileTree, _sfc_main$1 as VPFileTreeNode, enhanceAppWithFileTree };

package/dist/client/ssr/index.js

@@ -1,8 +1,8 @@
 import { computed, defineComponent, inject, mergeProps, ref, unref, useSSRContext } from "vue";
 import { ssrInterpolate, ssrRenderAttr, ssrRenderAttrs, ssrRenderClass, ssrRenderComponent, ssrRenderSlot, ssrRenderStyle } from "vue/server-renderer";
 import { VPCopyButton } from "vitepress-plugin-toolkit/client";
-//#region src/client/VPFileTree.vue
-const _sfc_main = /*@__PURE__*/ defineComponent({
+
+const _sfc_main =  defineComponent({
 	__name: "VPFileTree",
 	__ssrInlineRender: true,
 	props: {
@@ -28,26 +28,18 @@ const _sfc_main = /*@__PURE__*/ defineComponent({
 const _sfc_setup$1 = _sfc_main.setup;
 _sfc_main.setup = (props, ctx) => {
 	const ssrContext = useSSRContext();
-	(ssrContext.modules || (ssrContext.modules = /* @__PURE__ */ new Set())).add("src/client/VPFileTree.vue");
+	(ssrContext.modules || (ssrContext.modules =  new Set())).add("src/client/VPFileTree.vue");
 	return _sfc_setup$1 ? _sfc_setup$1(props, ctx) : void 0;
 };
-//#endregion
-//#region src/client/constants.ts
-/**
-* File tree node click event
-*
-* 文件树节点点击事件
-*/
+
+
+
 const ON_NODE_CLICK = Symbol(import.meta.env.DEV ? "on-file-tree-node-click" : "");
-/**
-* Active file tree node
-*
-* 当前激活的文件树节点
-*/
+
 const ACTIVE_NODE_KEY = Symbol(import.meta.env.DEV ? "active-file-tree-node" : "");
-//#endregion
-//#region src/client/VPFileTreeNode.vue
-const _sfc_main$1 = /*@__PURE__*/ defineComponent({
+
+
+const _sfc_main$1 =  defineComponent({
 	__name: "VPFileTreeNode",
 	__ssrInlineRender: true,
 	props: {
@@ -63,30 +55,12 @@ const _sfc_main$1 = /*@__PURE__*/ defineComponent({
 		const activeFileTreeNode = inject(ACTIVE_NODE_KEY, ref(""));
 		const onNodeClick = inject(ON_NODE_CLICK, () => {});
 		const active = ref(__props.expanded);
-		/**
-		* Notify the parent of a node click event via the injected callback.
-		*
-		* 通过注入的回调通知父组件节点点击事件。
-		*
-		* Ellipsis placeholders (`…` or `...`) are ignored to avoid triggering
-		* selection on empty folder markers.
-		*/
+		
 		function nodeClick() {
 			if (__props.filename === "…" || __props.filename === "...") return;
 			onNodeClick(__props.filepath || __props.filename, __props.type);
 		}
-		/**
-		* Handle click events on the node, toggling folder expansion or firing
-		* the node click callback for files.
-		*
-		* 处理节点的点击事件，切换文件夹展开状态或触发文件节点的点击回调。
-		*
-		* For folders, clicks on the comment area are ignored so that inline
-		* comments remain interactive. For files, the click callback fires
-		* directly.
-		*
-		* @param ev - Native mouse event / 原生鼠标事件
-		*/
+		
 		function toggle(ev) {
 			if (__props.type === "folder") {
 				if (!ev.target.matches(".comment, .comment *")) {
@@ -132,27 +106,15 @@ const _sfc_main$1 = /*@__PURE__*/ defineComponent({
 const _sfc_setup = _sfc_main$1.setup;
 _sfc_main$1.setup = (props, ctx) => {
 	const ssrContext = useSSRContext();
-	(ssrContext.modules || (ssrContext.modules = /* @__PURE__ */ new Set())).add("src/client/VPFileTreeNode.vue");
+	(ssrContext.modules || (ssrContext.modules =  new Set())).add("src/client/VPFileTreeNode.vue");
 	return _sfc_setup ? _sfc_setup(props, ctx) : void 0;
 };
-//#endregion
-//#region src/client/index.ts
-/**
-* Register file tree components globally during VitePress app enhancement.
-*
-* 在 VitePress 应用增强阶段全局注册文件树组件。
-*
-* Called automatically by the `virtual:enhance-app` module when the plugin
-* is loaded via `vitepress-tuck`'s `defineConfig`. Registers `VPFileTree`
-* and `VPFileTreeNode` as global Vue components so they can be used in
-* markdown-rendered HTML without explicit imports.
-*
-* @param ctx - VitePress enhance app context / VitePress 应用增强上下文
-* @param ctx.app - The VitePress Vue app instance / VitePress 的 Vue 应用实例
-*/
+
+
+
 function enhanceAppWithFileTree({ app }) {
 	if (!app._context.components.VPFileTree) app.component("VPFileTree", _sfc_main);
 	if (!app._context.components.VPFileTreeNode) app.component("VPFileTreeNode", _sfc_main$1);
 }
-//#endregion
+
 export { ACTIVE_NODE_KEY, ON_NODE_CLICK, _sfc_main as VPFileTree, _sfc_main$1 as VPFileTreeNode, enhanceAppWithFileTree };

package/dist/node/index.js

@@ -1,38 +1,8 @@
 import { definePlugin } from "vitepress-tuck";
 import { createContainerSyntaxPlugin, stringifyAttrs } from "vitepress-plugin-toolkit";
 import { removeTrailingSlash } from "@pengzhanbo/utils";
-//#region src/node/fileTreeToCMDText.ts
-/**
-* Convert file tree nodes into `tree` command-style plain text.
-*
-* 将文件树节点转换为 `tree` 命令风格的纯文本。
-*
-* Produces a string representation using `├──` and `└──` branch markers with
-* `│   ` and `    ` indentation, matching the output of the Unix `tree`
-* command. Ellipsis placeholder children (`…`) are filtered out so empty
-* folders render cleanly. The result is used by the copy button on the
-* rendered file tree.
-*
-* 使用 `├──` 和 `└──` 分支标记以及 `│` 和空格缩进生成字符串表示，与 Unix `tree` 命令的输出一致。
-* 省略号占位符子项（`…`）会被过滤掉，使得空文件夹显示整洁。该结果用于渲染文件树上的复制按钮。
-*
-* @param nodes - File tree nodes to convert / 要转换的文件树节点数组
-* @param prefix - Line prefix for recursive indentation / 递归缩进使用的行前缀
-* @returns CMD-style text representation / CMD 风格的文本表示
-*
-* @example
-* ```ts
-* const nodes = [
-*   { filename: 'src', type: 'folder', level: 0, children: [
-*     { filename: 'index.ts', type: 'file', level: 1, children: [] },
-*   ]},
-* ]
-* fileTreeToCMDText(nodes)
-* // .
-* // └── src
-* //     └── index.ts
-* ```
-*/
+
+
 function fileTreeToCMDText(nodes, prefix = "") {
 	let content = prefix ? "" : ".\n";
 	for (let i = 0, l = nodes.length; i < l; i++) {
@@ -43,44 +13,11 @@ function fileTreeToCMDText(nodes, prefix = "") {
 	}
 	return content;
 }
-//#endregion
-//#region src/node/parseNodeInfo.ts
-/**
-* Regular expression for the focus marker `**filename**`.
-*
-* 聚焦标记 `**filename**` 的正则表达式。
-*
-* A filename wrapped in double asterisks is highlighted as a focused node.
-* The marker may be followed by a space and an inline comment.
-*/
+
+
+
 const RE_FOCUS = /^\*\*(.*?)\*\*(?:$|\s+)/;
-/**
-* Parse a single node info string, extracting filename, comment, type, and
-* other metadata.
-*
-* 解析单个节点的 info 字符串，提取文件名、注释、类型等属性。
-*
-* Recognizes the following syntax within the info string:
-* - `++filename` — marks the node as a diff addition
-* - `--filename` — marks the node as a diff removal
-* - `**filename**` — highlights the node as focused
-* - `filename # comment` — attaches an inline comment after `#`
-* - `filename/` — treats the entry as a folder (trailing slash removed)
-*
-* @param info - Node description string / 节点描述字符串
-* @returns File tree node properties excluding `children` and `level` / 文件树节点属性（不含 `children` 和 `level`）
-*
-* @example
-* ```ts
-* parseNodeInfo('src/  # source folder')
-* // { filename: 'src', comment: '# source folder', focus: false,
-* //   expanded: false, type: 'folder', diff: undefined }
-*
-* parseNodeInfo('**index.ts**')
-* // { filename: 'index.ts', comment: '', focus: true,
-* //   expanded: true, type: 'file', diff: undefined }
-* ```
-*/
+
 function parseNodeInfo(info) {
 	let filename = "";
 	let comment = "";
@@ -120,33 +57,9 @@ function parseNodeInfo(info) {
 		diff
 	};
 }
-//#endregion
-//#region src/node/parseContentWithContainer.ts
-/**
-* Parse the content from the `::: file-tree` container into a node tree structure.
-*
-* 从 `::: file-tree` 容器中解析内容为节点树结构。
-*
-* Accepts indented list-style text where each entry starts with `- ` and
-* indentation is measured in two-space increments. The first line's leading
-* whitespace is stripped to normalize the root level. Each entry is passed
-* to `parseNodeInfo` to extract the filename, comment, type, and other
-* metadata.
-*
-* @param content - Raw file tree text content / 文件树的原始文本内容
-* @returns File tree node array / 文件树节点数组
-*
-* @example
-* ```ts
-* const content = `
-* - src/  # source folder
-*   - index.ts
-*   - utils.ts
-* - package.json
-* `
-* parseContentWithContainer(content)
-* ```
-*/
+
+
+
 function parseContentWithContainer(content) {
 	const root = {
 		level: -1,
@@ -154,7 +67,7 @@ function parseContentWithContainer(content) {
 	};
 	const stack = [root];
 	const lines = content.trimEnd().split("\n");
-	/* v8 ignore next */
+	
 	const spaceLength = lines[0]?.match(/^\s*/)?.[0].length ?? 0;
 	for (const line of lines) {
 		const match = line.match(/^(\s*)-(.*)$/);
@@ -173,47 +86,11 @@ function parseContentWithContainer(content) {
 	}
 	return root.children;
 }
-//#endregion
-//#region src/node/parseContentWithFence.ts
-/**
-* Regular expression for matching a single line of `tree` command output.
-*
-* 匹配 `tree` 命令输出的单行正则。
-*
-* Matches lines like:
-*   ├── filename
-*   │   ├── filename
-*   │   └── filename
-*   └── filename  # optional comment
-*
-* - Group 1: prefix segments, each is either `│   ` (has next sibling) or `    ` (last sibling)
-* - Group 2: branch marker, either `├── ` (non-last) or `└── ` (last)
-* - Group 3: the filename with optional comment
-*/
+
+
+
 const TREE_LINE_RE = /^((?:│ {3}| {4})*)([├└]── )(.+)$/u;
-/**
-* Parse `tree` command output format into a structured file tree node array.
-*
-* 将 `tree` 命令行输出格式解析为结构化的文件树节点数组。
-*
-* Converts text like:
-* ```
-* .
-* ├── src
-* │   ├── index.ts
-* │   └── utils.ts
-* └── package.json  # project config
-* ```
-*
-* into a `FileTreeNode[]` tree structure, with support for inline comments
-* (text after `#`) on each entry. The leading root marker line (`.`) is
-* skipped if present. Indentation depth is derived from the 4-character
-* prefix segments, and any parent node that gains children is automatically
-* promoted to the `folder` type.
-*
-* @param content - Raw `tree` command output text / `tree` 命令输出的原始文本
-* @returns Structured file tree node array / 结构化的文件树节点数组
-*/
+
 function parseContentWithFence(content) {
 	const root = {
 		level: -1,
@@ -241,57 +118,11 @@ function parseContentWithFence(content) {
 	}
 	return root.children;
 }
-//#endregion
-//#region src/node/markdown.ts
-/**
-* markdown-it plugin for rendering file tree diagrams.
-*
-* 用于渲染文件树图的 markdown-it 插件。
-*
-* Supports two syntaxes:
-* - Container syntax: `::: file-tree` blocks with `- filename` indented entries
-* - Fence syntax: ` ```tree ` or ` ```file-tree ` code blocks with `tree` command output
-*
-* The plugin converts the parsed tree structure into nested `<VPFileTreeNode>`
-* components wrapped by a `<VPFileTree>` container, with a URL-encoded
-* plain-text representation for the copy button.
-*
-* 支持两种语法：
-* - 容器语法：`::: file-tree` 块，其中包含以 `- 文件名` 缩进的条目
-* - 围栏语法：` ```tree ` 或 ` ```file-tree ` 代码块，其中包含 `tree` 命令的输出
-*
-* 该插件将解析后的树结构转换为由 `<VPFileTree>` 容器包裹的嵌套 `<VPFileTreeNode>` 组件，并附带一个 URL 编码的纯文本表示，用于复制按钮。
-*
-* @example
-* ```ts
-* import { fileTreeMarkdownPlugin } from 'vitepress-plugin-file-tree'
-* import { defineConfig } from 'vitepress'
-* export default defineConfig({
-*   markdown: {
-*     config: (md) => {
-*       md.use(fileTreeMarkdownPlugin)
-*     },
-*   },
-* })
-* ```
-*/
+
+
+
 const fileTreeMarkdownPlugin = (md) => {
-	/**
-	* Recursively render file tree nodes into nested `<VPFileTreeNode>` markup.
-	*
-	* 递归地将文件树节点渲染为嵌套的 `<VPFileTreeNode>` 标记。
-	*
-	* Empty folders automatically receive an ellipsis placeholder child so the
-	* folder icon is displayed correctly. Inline comments are rendered through
-	* `md.renderInline` and passed via the `#comment` slot.
-	*
-	* 空文件夹会自动获得一个省略号占位符子项，以便正确显示文件夹图标。
-	* 内联注释通过 `md.renderInline` 渲染，并通过 `#comment` 插槽传递。
-	*
-	* @param nodes - File tree nodes to render / 要渲染的文件树节点数组
-	* @param meta - Container-level attributes / 容器级属性
-	* @returns Rendered HTML string of nested nodes / 嵌套节点的 HTML 字符串
-	*/
+	
 	const renderFileTree = (nodes, meta) => nodes.map((node) => {
 		const { level, children, filename, comment, focus, expanded, type, diff } = node;
 		if (children.length === 0 && type === "folder") children.push({
@@ -334,34 +165,9 @@ ${renderedComment}${children.length > 0 ? renderFileTree(children, meta) : ""}
 		return `<VPFileTree text="${encodeURIComponent(text)}">${renderFileTree(nodes, {})}</VPFileTree>`;
 	};
 };
-//#endregion
-//#region src/node/plugin.ts
-/**
-* VitePress plugin for rendering file tree diagrams in markdown.
-*
-* VitePress 插件，用于在 markdown 中渲染文件树图。
-*
-* Registers the `fileTreeMarkdownPlugin` with markdown-it to parse both
-* container syntax (`::: file-tree`) and fence syntax (` ```tree ` or
-* ` ```file-tree `) into interactive collapsible file trees. On the client
-* side, the `VPFileTree` and `VPFileTreeNode` Vue components are injected
-* globally via `virtual:enhance-app`.
-*
-* The rendered tree supports inline comments, focus highlights, diff markers
-* for added or removed entries, and a copy button that outputs the plain-text
-* `tree` command representation.
-*
-* @example
-* `.vitepress/config.ts`
-* ```ts
-* import { defineConfig } from 'vitepress-tuck'
-* import fileTree from 'vitepress-plugin-file-tree'
-*
-* export default defineConfig({
-*   plugins: [fileTree()],
-* })
-* ```
-*/
+
+
+
 const fileTree = definePlugin(() => ({
 	name: "vitepress-plugin-file-tree",
 	componentResolver: ["VPFileTree", "VPFileTreeNode"],
@@ -373,16 +179,9 @@ const fileTree = definePlugin(() => ({
 		ssr: { noExternal: ["vitepress-plugin-file-tree"] }
 	}
 }));
-//#endregion
-//#region src/node/index.ts
-/**
-* Entry point for the `vitepress-plugin-file-tree` package.
-*
-* `vitepress-plugin-file-tree` 插件的入口模块。
-*
-* Re-exports all node-side utilities, the markdown-it plugin, parsing helpers,
-* and the main `fileTree` plugin definition as the default export.
-*/
+
+
+
 var node_default = fileTree;
-//#endregion
+
 export { node_default as default, fileTree, fileTreeMarkdownPlugin, fileTreeToCMDText, parseContentWithContainer, parseContentWithFence, parseNodeInfo };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vitepress-plugin-file-tree",
   "type": "module",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Render file tree structure in your VitePress site.",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
   "license": "MIT",
@@ -37,10 +37,10 @@
     "vue": "^3.5.0"
   },
   "dependencies": {
-    "@pengzhanbo/utils": "^3.7.3",
+    "@pengzhanbo/utils": "^3.7.4",
     "@vueuse/core": "^14.3.0",
-    "vitepress-plugin-toolkit": "0.9.0",
-    "vitepress-tuck": "0.9.0"
+    "vitepress-plugin-toolkit": "0.11.0",
+    "vitepress-tuck": "0.11.0"
   },
   "publishConfig": {
     "access": "public",