func2md 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 青菜白玉汤
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,125 @@
+# func2md
+
+A Vite plugin to generate VitePress documentation from JSDoc and TypeScript types.
+
+## Features
+
+- Scans specified directories for JavaScript/TypeScript functions
+- Parses JSDoc comments to extract function information
+- Generates Markdown documentation compatible with VitePress
+- Supports customizable scanning directories and output locations
+- Integrates with Vite's build process
+
+## Installation
+
+```bash
+npm install func2md
+```
+
+## Usage
+
+### Basic usage
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+import func2md from 'func2md'
+
+export default defineConfig({
+  plugins: [
+    func2md({
+      srcDir: 'src',     // Source directory to scan for functions
+      outDir: 'docs',    // Output directory for generated markdown files
+      watch: false       // Whether to watch for changes
+    })
+  ]
+})
+```
+
+### Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| srcDir | string | 'src' | Source directory to scan for functions |
+| outDir | string | 'docs' | Output directory for generated markdown files |
+| watch | boolean | false | Whether to watch for changes |
+
+## JSDoc Format
+
+The plugin parses JSDoc comments with the following special tags:
+
+- `@title` - Function title (optional, defaults to first line of description)
+- `@param` - Function parameters with type and description
+- `@returns` or `@return` - Return value with type and description
+- `@example` - Code example
+
+Example:
+
+```js
+/**
+ * @title Add two numbers
+ * This function adds two numbers together
+ * @param {number} a - First number
+ * @param {number} b - Second number
+ * @returns {number} The sum of a and b
+ * @example
+ * import { add } from './math'
+ * const result = add(1, 2) // returns 3
+ */
+function add(a, b) {
+  return a + b
+}
+```
+
+## Generated Documentation
+
+The plugin generates Markdown files with the following structure:
+
+```markdown
+# Function Title
+
+## INFO
+
+Function description
+
+## Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| paramName | `type` | Parameter description |
+
+## Return Value
+
+- Type: `returnType`
+- Description: Return value description
+
+## Examples
+
+```ts
+// Example code
+```
+```
+
+## Development
+
+### Build the project
+
+```bash
+npm run build
+```
+
+### Run tests
+
+```bash
+npm run test
+```
+
+### Run tests with coverage
+
+```bash
+npm run test:coverage
+```
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,125 @@
+# func2md
+
+一个用于从 JSDoc 和 TypeScript 类型生成 VitePress 文档的 Vite 插件。
+
+## 功能特性
+
+- 扫描指定目录中的 JavaScript/TypeScript 函数
+- 解析 JSDoc 注释以提取函数信息
+- 生成与 VitePress 兼容的 Markdown 文档
+- 支持自定义扫描目录和输出位置
+- 与 Vite 构建过程集成
+
+## 安装
+
+```bash
+npm install func2md
+```
+
+## 使用方法
+
+### 基本用法
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+import func2md from 'func2md'
+
+export default defineConfig({
+  plugins: [
+    func2md({
+      srcDir: 'src',     // 要扫描函数的源目录
+      outDir: 'docs',    // 生成的 markdown 文件的输出目录
+      watch: false       // 是否监听变化
+    })
+  ]
+})
+```
+
+### 配置选项
+
+| 选项 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| srcDir | string | 'src' | 要扫描函数的源目录 |
+| outDir | string | 'docs' | 生成的 markdown 文件的输出目录 |
+| watch | boolean | false | 是否监听变化 |
+
+## JSDoc 格式
+
+插件解析具有以下特殊标签的 JSDoc 注释：
+
+- `@title` - 函数标题（可选，默认为描述的第一行）
+- `@param` - 带类型和描述的函数参数
+- `@returns` 或 `@return` - 带类型和描述的返回值
+- `@example` - 代码示例
+
+示例：
+
+```js
+/**
+ * @title 两数相加
+ * 这个函数将两个数字相加
+ * @param {number} a - 第一个数字
+ * @param {number} b - 第二个数字
+ * @returns {number} a 和 b 的和
+ * @example
+ * import { add } from './math'
+ * const result = add(1, 2) // 返回 3
+ */
+function add(a, b) {
+  return a + b
+}
+```
+
+## 生成的文档
+
+插件生成具有以下结构的 Markdown 文件：
+
+```markdown
+# 函数标题
+
+## INFO
+
+函数描述
+
+## 参数
+
+| 参数名 | 类型 | 说明 |
+|--------|------|------|
+| paramName | `type` | 参数描述 |
+
+## 返回值
+
+- 类型: `returnType`
+- 说明: 返回值描述
+
+## 示例
+
+```ts
+// 示例代码
+```
+```
+
+## 开发
+
+### 构建项目
+
+```bash
+npm run build
+```
+
+### 运行测试
+
+```bash
+npm run test
+```
+
+### 运行带覆盖率的测试
+
+```bash
+npm run test:coverage
+```
+
+## 许可证
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,175 @@
+let fs = require("fs");
+let path = require("path");
+
+//#region src/utils/file-utils.ts
+function findAllFiles(dir, extensions) {
+	let results = [];
+	function traverse(currentDir) {
+		const files = (0, fs.readdirSync)(currentDir);
+		for (const file of files) {
+			const filePath = (0, path.join)(currentDir, file);
+			const stat = (0, fs.statSync)(filePath);
+			if (stat.isDirectory()) traverse(filePath);
+			else if (stat.isFile() && extensions.includes((0, path.extname)(file))) results.push(filePath);
+		}
+	}
+	traverse(dir);
+	return results;
+}
+
+//#endregion
+//#region src/utils/jsdoc-parser.ts
+function parseJSDoc(jsdoc) {
+	const lines = jsdoc.trim().split("\n").map((line) => line.replace(/^\s*\*\s?/, ""));
+	const info = {};
+	const titleMatch = lines.find((line) => line.startsWith("@title"));
+	if (titleMatch) info.title = titleMatch.replace("@title", "").trim();
+	else if (lines.length > 0) info.title = lines[0];
+	const descLines = [];
+	for (const line of lines) {
+		if (line.startsWith("@example") || line.startsWith("@param") || line.startsWith("@returns") || line.startsWith("@return")) break;
+		if (!line.startsWith("@title") && line.trim() !== "") descLines.push(line);
+	}
+	if (descLines.length > 0) info.desc = descLines.join(" ").trim();
+	const exampleLines = [];
+	let collectingExample = false;
+	for (const line of lines) {
+		if (line.startsWith("@example")) {
+			collectingExample = true;
+			const exampleContent = line.replace("@example", "").trim();
+			if (exampleContent) exampleLines.push(exampleContent);
+			continue;
+		}
+		if (collectingExample) if (line.startsWith("@")) collectingExample = false;
+		else exampleLines.push(line);
+	}
+	if (exampleLines.length > 0) info.example = exampleLines.join("\n").trim();
+	info.params = [];
+	lines.forEach((line) => {
+		const paramMatch = line.match(/@param\s+{([^}]+)}\s+(\w+)\s+(.+)/);
+		if (paramMatch) info.params.push({
+			name: paramMatch[2],
+			type: paramMatch[1],
+			description: paramMatch[3]
+		});
+	});
+	const returnMatch = lines.find((line) => line.startsWith("@returns") || line.startsWith("@return"));
+	if (returnMatch) {
+		const returnInfo = returnMatch.replace(/@(returns?)/, "").trim();
+		const typeMatch = returnInfo.match(/^{([^}]+)}\s*(.*)/);
+		if (typeMatch) info.returns = {
+			type: typeMatch[1],
+			description: typeMatch[2]
+		};
+		else info.returns = {
+			type: "unknown",
+			description: returnInfo
+		};
+	}
+	return info;
+}
+
+//#endregion
+//#region src/utils/function-extractor.ts
+function extractFunctions(content, filePath) {
+	const functions = [];
+	const functionRegex = new RegExp(String.raw`/\*\*((?:.|\n|\r)*?)\*/\s*(export\s+)?(async\s+)?function\s+(\w+)`, "g");
+	let match;
+	while ((match = functionRegex.exec(content)) !== null) {
+		const [, jsdocRaw, , , functionName] = match;
+		const jsdoc = parseJSDoc(jsdocRaw);
+		functions.push({
+			name: functionName,
+			jsdoc,
+			filePath
+		});
+	}
+	return functions;
+}
+
+//#endregion
+//#region src/generators/markdown-generator.ts
+function generateTitleSection(func) {
+	const { name, jsdoc } = func;
+	return `# ${jsdoc.title || name}\n\n`;
+}
+function generateDescriptionSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.desc) return `## 说明\n\n${jsdoc.desc}\n\n`;
+	return "";
+}
+function generateSignatureSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.signature) return `## 签名\n\n\`\`\`ts\n${jsdoc.signature}\n\`\`\`\n\n`;
+	return "";
+}
+function generateParametersSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.params && jsdoc.params.length > 0) {
+		let section = `## 参数\n\n`;
+		section += `| 参数名 | 类型 | 说明 |\n|--------|------|------|\n`;
+		jsdoc.params.forEach((param) => {
+			section += `| ${param.name} | \`${param.type}\` | ${param.description} |\n`;
+		});
+		section += `\n`;
+		return section;
+	}
+	return "";
+}
+function generateReturnsSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.returns) return `## 返回值\n\n- 类型: \`${jsdoc.returns.type}\`\n- 说明: ${jsdoc.returns.description}\n\n`;
+	return "";
+}
+function generateExampleSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.example) return `## 示例\n\n\`\`\`ts\n${jsdoc.example}\n\`\`\`\n\n`;
+	return "";
+}
+function generateMarkdown(func) {
+	let md = generateTitleSection(func);
+	md += generateDescriptionSection(func);
+	md += generateSignatureSection(func);
+	md += generateParametersSection(func);
+	md += generateReturnsSection(func);
+	md += generateExampleSection(func);
+	return md;
+}
+
+//#endregion
+//#region src/core/scanner.ts
+async function scanAndGenerateDocs(srcDir, outDir) {
+	console.log(`Scanning ${srcDir} and generating docs to ${outDir}`);
+	const files = findAllFiles(srcDir, [".ts", ".js"]);
+	for (const file of files) {
+		const functions = extractFunctions((0, fs.readFileSync)(file, "utf-8"), file);
+		for (const func of functions) {
+			const mdContent = generateMarkdown(func);
+			const outputPath = (0, path.join)(outDir, `${func.name}.md`);
+			(0, fs.writeFileSync)(outputPath, mdContent);
+			console.log(`Generated documentation: ${outputPath}`);
+		}
+	}
+}
+
+//#endregion
+//#region src/index.ts
+function func2md(options = {}) {
+	const { srcDir = "src", outDir = "docs", watch = false } = options;
+	const resolvedSrcDir = (0, path.resolve)(srcDir);
+	const resolvedOutDir = (0, path.resolve)(outDir);
+	return {
+		name: "func2md",
+		async buildStart() {
+			if (!(0, fs.existsSync)(resolvedOutDir)) (0, fs.mkdirSync)(resolvedOutDir, { recursive: true });
+			await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir);
+		},
+		async handleHotUpdate(ctx) {
+			if (watch && ctx.file.includes(resolvedSrcDir)) await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir);
+		}
+	};
+}
+
+//#endregion
+module.exports = func2md;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/utils/file-utils.ts","../src/utils/jsdoc-parser.ts","../src/utils/function-extractor.ts","../src/generators/markdown-generator.ts","../src/core/scanner.ts","../src/index.ts"],"sourcesContent":["import { readdirSync, statSync } from 'fs'\nimport { join, extname } from 'path'\n\nexport function findAllFiles(dir: string, extensions: string[]): string[] {\n  let results: string[] = []\n  \n  function traverse(currentDir: string) {\n    const files = readdirSync(currentDir)\n    \n    for (const file of files) {\n      const filePath = join(currentDir, file)\n      const stat = statSync(filePath)\n      \n      if (stat.isDirectory()) {\n        traverse(filePath)\n      } else if (stat.isFile() && extensions.includes(extname(file))) {\n        results.push(filePath)\n      }\n    }\n  }\n  \n  traverse(dir)\n  return results\n}","export interface JSDocInfo {\n  title?: string\n  desc?: string\n  example?: string\n  params?: Array<{\n    name: string\n    type: string\n    description: string\n  }>\n  returns?: {\n    type: string\n    description: string\n  }\n  signature?: string\n}\n\nexport function parseJSDoc(jsdoc: string): JSDocInfo {\n  const lines = jsdoc.trim().split('\\n').map(line => line.replace(/^\\s*\\*\\s?/, ''))\n  \n  const info: JSDocInfo = {}\n  \n  // Extract title (first line or @title tag)\n  const titleMatch = lines.find(line => line.startsWith('@title'))\n  if (titleMatch) {\n    info.title = titleMatch.replace('@title', '').trim()\n  } else if (lines.length > 0) {\n    info.title = lines[0]\n  }\n  \n  // Extract description - all lines that don't start with @\n  const descLines: string[] = []\n  let inExample = false\n  for (const line of lines) {\n    // Stop collecting description when we hit @example or @param or @returns\n    if (line.startsWith('@example') || line.startsWith('@param') || line.startsWith('@returns') || line.startsWith('@return')) {\n      break\n    }\n    \n    // Only add non-empty lines that don't start with @title to description\n    if (!line.startsWith('@title') && line.trim() !== '') {\n      descLines.push(line)\n    }\n  }\n  \n  if (descLines.length > 0) {\n    info.desc = descLines.join(' ').trim()\n  }\n  \n  // Extract example\n  const exampleLines: string[] = []\n  let collectingExample = false\n  for (const line of lines) {\n    if (line.startsWith('@example')) {\n      collectingExample = true\n      const exampleContent = line.replace('@example', '').trim()\n      if (exampleContent) {\n        exampleLines.push(exampleContent)\n      }\n      continue\n    }\n    \n    // Continue collecting example lines until we hit another tag\n    if (collectingExample) {\n      if (line.startsWith('@')) {\n        collectingExample = false\n      } else {\n        exampleLines.push(line)\n      }\n    }\n  }\n  \n  if (exampleLines.length > 0) {\n    info.example = exampleLines.join('\\n').trim()\n  }\n  \n  // Extract parameters\n  info.params = []\n  lines.forEach(line => {\n    const paramMatch = line.match(/@param\\s+{([^}]+)}\\s+(\\w+)\\s+(.+)/)\n    if (paramMatch) {\n      info.params!.push({\n        name: paramMatch[2],\n        type: paramMatch[1],\n        description: paramMatch[3]\n      })\n    }\n  })\n  \n  // Extract return value\n  const returnMatch = lines.find(line => line.startsWith('@returns') || line.startsWith('@return'))\n  if (returnMatch) {\n    const returnInfo = returnMatch.replace(/@(returns?)/, '').trim()\n    const typeMatch = returnInfo.match(/^{([^}]+)}\\s*(.*)/)\n    if (typeMatch) {\n      info.returns = {\n        type: typeMatch[1],\n        description: typeMatch[2]\n      }\n    } else {\n      info.returns = {\n        type: 'unknown',\n        description: returnInfo\n      }\n    }\n  }\n  \n  return info\n}","import { parseJSDoc, JSDocInfo } from './jsdoc-parser'\n\nexport interface FunctionInfo {\n  name: string\n  jsdoc: JSDocInfo\n  signature?: string\n  filePath: string\n}\n\nexport function extractFunctions(content: string, filePath: string): FunctionInfo[] {\n  // This is a simplified implementation\n  // In a real implementation, we would use AST parsing (e.g., with TypeScript Compiler API)\n  \n  const functions: FunctionInfo[] = []\n  \n  // Match function declarations with JSDoc comments\n  // Using a string to avoid regex escaping issues\n  const functionRegex = new RegExp(\n    String.raw`/\\*\\*((?:.|\\n|\\r)*?)\\*/\\s*(export\\s+)?(async\\s+)?function\\s+(\\w+)`,\n    'g'\n  )\n  let match\n  \n  while ((match = functionRegex.exec(content)) !== null) {\n    const [, jsdocRaw, , , functionName] = match\n    const jsdoc = parseJSDoc(jsdocRaw)\n    \n    functions.push({\n      name: functionName,\n      jsdoc,\n      filePath\n    })\n  }\n  \n  return functions\n}","import { FunctionInfo } from '../utils/function-extractor'\n\n// Generate the main title section\nexport function generateTitleSection(func: FunctionInfo): string {\n  const { name, jsdoc } = func\n  const title = jsdoc.title || name\n  return `# ${title}\\n\\n`\n}\n\n// Generate the description section\nexport function generateDescriptionSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.desc) {\n    return `## 说明\\n\\n${jsdoc.desc}\\n\\n`\n  }\n  return ''\n}\n\n// Generate the signature section\nexport function generateSignatureSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.signature) {\n    return `## 签名\\n\\n\\`\\`\\`ts\\n${jsdoc.signature}\\n\\`\\`\\`\\n\\n`\n  }\n  return ''\n}\n\n// Generate the parameters section\nexport function generateParametersSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.params && jsdoc.params.length > 0) {\n    let section = `## 参数\\n\\n`\n    section += `| 参数名 | 类型 | 说明 |\\n|--------|------|------|\\n`\n    jsdoc.params.forEach(param => {\n      section += `| ${param.name} | \\`${param.type}\\` | ${param.description} |\\n`\n    })\n    section += `\\n`\n    return section\n  }\n  return ''\n}\n\n// Generate the returns section\nexport function generateReturnsSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.returns) {\n    return `## 返回值\\n\\n- 类型: \\`${jsdoc.returns.type}\\`\\n- 说明: ${jsdoc.returns.description}\\n\\n`\n  }\n  return ''\n}\n\n// Generate the example section\nexport function generateExampleSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.example) {\n    return `## 示例\\n\\n\\`\\`\\`ts\\n${jsdoc.example}\\n\\`\\`\\`\\n\\n`\n  }\n  return ''\n}\n\n// Main function to generate markdown content\nexport function generateMarkdown(func: FunctionInfo): string {\n  let md = generateTitleSection(func)\n  md += generateDescriptionSection(func)\n  md += generateSignatureSection(func)\n  md += generateParametersSection(func)\n  md += generateReturnsSection(func)\n  md += generateExampleSection(func)\n  return md\n}","import { readFileSync, writeFileSync } from 'fs'\nimport { join } from 'path'\nimport { findAllFiles } from '../utils/file-utils'\nimport { extractFunctions } from '../utils/function-extractor'\nimport { generateMarkdown } from '../generators/markdown-generator'\n\nexport async function scanAndGenerateDocs(srcDir: string, outDir: string) {\n  console.log(`Scanning ${srcDir} and generating docs to ${outDir}`)\n  \n  // Find all .ts and .js files in srcDir\n  const files = findAllFiles(srcDir, ['.ts', '.js'])\n  \n  for (const file of files) {\n    const content = readFileSync(file, 'utf-8')\n    const functions = extractFunctions(content, file)\n    \n    for (const func of functions) {\n      const mdContent = generateMarkdown(func)\n      const outputPath = join(outDir, `${func.name}.md`)\n      writeFileSync(outputPath, mdContent)\n      console.log(`Generated documentation: ${outputPath}`)\n    }\n  }\n}","import type { Plugin } from 'vite'\nimport { existsSync, mkdirSync } from 'fs'\nimport { resolve } from 'path'\nimport { scanAndGenerateDocs } from './core/scanner'\n\nexport interface Func2MdOptions {\n  /**\n   * Source directory to scan for functions\n   * @default 'src'\n   */\n  srcDir?: string\n  \n  /**\n   * Output directory for generated markdown files\n   * @default 'docs'\n   */\n  outDir?: string\n  \n  /**\n   * Whether to watch for changes\n   * @default false\n   */\n  watch?: boolean\n}\n\nexport default function func2md(options: Func2MdOptions = {}): Plugin {\n  const { \n    srcDir = 'src', \n    outDir = 'docs',\n    watch = false\n  } = options\n  \n  const resolvedSrcDir = resolve(srcDir)\n  const resolvedOutDir = resolve(outDir)\n  \n  return {\n    name: 'func2md',\n    \n    async buildStart() {\n      if (!existsSync(resolvedOutDir)) {\n        mkdirSync(resolvedOutDir, { recursive: true })\n      }\n      \n      // Scan files and generate docs\n      await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir)\n    },\n    \n    async handleHotUpdate(ctx) {\n      if (watch && ctx.file.includes(resolvedSrcDir)) {\n        await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir)\n      }\n    }\n  }\n}"],"mappings":";;;;AAGA,SAAgB,aAAa,KAAa,YAAgC;CACxE,IAAI,UAAoB,EAAE;CAE1B,SAAS,SAAS,YAAoB;EACpC,MAAM,4BAAoB,WAAW;AAErC,OAAK,MAAM,QAAQ,OAAO;GACxB,MAAM,0BAAgB,YAAY,KAAK;GACvC,MAAM,wBAAgB,SAAS;AAE/B,OAAI,KAAK,aAAa,CACpB,UAAS,SAAS;YACT,KAAK,QAAQ,IAAI,WAAW,2BAAiB,KAAK,CAAC,CAC5D,SAAQ,KAAK,SAAS;;;AAK5B,UAAS,IAAI;AACb,QAAO;;;;;ACNT,SAAgB,WAAW,OAA0B;CACnD,MAAM,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,KAAI,SAAQ,KAAK,QAAQ,aAAa,GAAG,CAAC;CAEjF,MAAM,OAAkB,EAAE;CAG1B,MAAM,aAAa,MAAM,MAAK,SAAQ,KAAK,WAAW,SAAS,CAAC;AAChE,KAAI,WACF,MAAK,QAAQ,WAAW,QAAQ,UAAU,GAAG,CAAC,MAAM;UAC3C,MAAM,SAAS,EACxB,MAAK,QAAQ,MAAM;CAIrB,MAAM,YAAsB,EAAE;AAE9B,MAAK,MAAM,QAAQ,OAAO;AAExB,MAAI,KAAK,WAAW,WAAW,IAAI,KAAK,WAAW,SAAS,IAAI,KAAK,WAAW,WAAW,IAAI,KAAK,WAAW,UAAU,CACvH;AAIF,MAAI,CAAC,KAAK,WAAW,SAAS,IAAI,KAAK,MAAM,KAAK,GAChD,WAAU,KAAK,KAAK;;AAIxB,KAAI,UAAU,SAAS,EACrB,MAAK,OAAO,UAAU,KAAK,IAAI,CAAC,MAAM;CAIxC,MAAM,eAAyB,EAAE;CACjC,IAAI,oBAAoB;AACxB,MAAK,MAAM,QAAQ,OAAO;AACxB,MAAI,KAAK,WAAW,WAAW,EAAE;AAC/B,uBAAoB;GACpB,MAAM,iBAAiB,KAAK,QAAQ,YAAY,GAAG,CAAC,MAAM;AAC1D,OAAI,eACF,cAAa,KAAK,eAAe;AAEnC;;AAIF,MAAI,kBACF,KAAI,KAAK,WAAW,IAAI,CACtB,qBAAoB;MAEpB,cAAa,KAAK,KAAK;;AAK7B,KAAI,aAAa,SAAS,EACxB,MAAK,UAAU,aAAa,KAAK,KAAK,CAAC,MAAM;AAI/C,MAAK,SAAS,EAAE;AAChB,OAAM,SAAQ,SAAQ;EACpB,MAAM,aAAa,KAAK,MAAM,oCAAoC;AAClE,MAAI,WACF,MAAK,OAAQ,KAAK;GAChB,MAAM,WAAW;GACjB,MAAM,WAAW;GACjB,aAAa,WAAW;GACzB,CAAC;GAEJ;CAGF,MAAM,cAAc,MAAM,MAAK,SAAQ,KAAK,WAAW,WAAW,IAAI,KAAK,WAAW,UAAU,CAAC;AACjG,KAAI,aAAa;EACf,MAAM,aAAa,YAAY,QAAQ,eAAe,GAAG,CAAC,MAAM;EAChE,MAAM,YAAY,WAAW,MAAM,oBAAoB;AACvD,MAAI,UACF,MAAK,UAAU;GACb,MAAM,UAAU;GAChB,aAAa,UAAU;GACxB;MAED,MAAK,UAAU;GACb,MAAM;GACN,aAAa;GACd;;AAIL,QAAO;;;;;ACjGT,SAAgB,iBAAiB,SAAiB,UAAkC;CAIlF,MAAM,YAA4B,EAAE;CAIpC,MAAM,gBAAgB,IAAI,OACxB,OAAO,GAAG,qEACV,IACD;CACD,IAAI;AAEJ,SAAQ,QAAQ,cAAc,KAAK,QAAQ,MAAM,MAAM;EACrD,MAAM,GAAG,cAAc,gBAAgB;EACvC,MAAM,QAAQ,WAAW,SAAS;AAElC,YAAU,KAAK;GACb,MAAM;GACN;GACA;GACD,CAAC;;AAGJ,QAAO;;;;;AC/BT,SAAgB,qBAAqB,MAA4B;CAC/D,MAAM,EAAE,MAAM,UAAU;AAExB,QAAO,KADO,MAAM,SAAS,KACX;;AAIpB,SAAgB,2BAA2B,MAA4B;CACrE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,KACR,QAAO,YAAY,MAAM,KAAK;AAEhC,QAAO;;AAIT,SAAgB,yBAAyB,MAA4B;CACnE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,UACR,QAAO,sBAAsB,MAAM,UAAU;AAE/C,QAAO;;AAIT,SAAgB,0BAA0B,MAA4B;CACpE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,UAAU,MAAM,OAAO,SAAS,GAAG;EAC3C,IAAI,UAAU;AACd,aAAW;AACX,QAAM,OAAO,SAAQ,UAAS;AAC5B,cAAW,KAAK,MAAM,KAAK,OAAO,MAAM,KAAK,OAAO,MAAM,YAAY;IACtE;AACF,aAAW;AACX,SAAO;;AAET,QAAO;;AAIT,SAAgB,uBAAuB,MAA4B;CACjE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,QACR,QAAO,qBAAqB,MAAM,QAAQ,KAAK,YAAY,MAAM,QAAQ,YAAY;AAEvF,QAAO;;AAIT,SAAgB,uBAAuB,MAA4B;CACjE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,QACR,QAAO,sBAAsB,MAAM,QAAQ;AAE7C,QAAO;;AAIT,SAAgB,iBAAiB,MAA4B;CAC3D,IAAI,KAAK,qBAAqB,KAAK;AACnC,OAAM,2BAA2B,KAAK;AACtC,OAAM,yBAAyB,KAAK;AACpC,OAAM,0BAA0B,KAAK;AACrC,OAAM,uBAAuB,KAAK;AAClC,OAAM,uBAAuB,KAAK;AAClC,QAAO;;;;;AC9DT,eAAsB,oBAAoB,QAAgB,QAAgB;AACxE,SAAQ,IAAI,YAAY,OAAO,0BAA0B,SAAS;CAGlE,MAAM,QAAQ,aAAa,QAAQ,CAAC,OAAO,MAAM,CAAC;AAElD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,YAAY,sCADW,MAAM,QAAQ,EACC,KAAK;AAEjD,OAAK,MAAM,QAAQ,WAAW;GAC5B,MAAM,YAAY,iBAAiB,KAAK;GACxC,MAAM,4BAAkB,QAAQ,GAAG,KAAK,KAAK,KAAK;AAClD,yBAAc,YAAY,UAAU;AACpC,WAAQ,IAAI,4BAA4B,aAAa;;;;;;;ACK3D,SAAwB,QAAQ,UAA0B,EAAE,EAAU;CACpE,MAAM,EACJ,SAAS,OACT,SAAS,QACT,QAAQ,UACN;CAEJ,MAAM,mCAAyB,OAAO;CACtC,MAAM,mCAAyB,OAAO;AAEtC,QAAO;EACL,MAAM;EAEN,MAAM,aAAa;AACjB,OAAI,oBAAY,eAAe,CAC7B,mBAAU,gBAAgB,EAAE,WAAW,MAAM,CAAC;AAIhD,SAAM,oBAAoB,gBAAgB,eAAe;;EAG3D,MAAM,gBAAgB,KAAK;AACzB,OAAI,SAAS,IAAI,KAAK,SAAS,eAAe,CAC5C,OAAM,oBAAoB,gBAAgB,eAAe;;EAG9D"}

package/dist/index.d.cts

@@ -0,0 +1,24 @@
+import { Plugin } from "vite";
+
+//#region src/index.d.ts
+interface Func2MdOptions {
+  /**
+       * Source directory to scan for functions
+       * @default 'src'
+       */
+  srcDir?: string;
+  /**
+       * Output directory for generated markdown files
+       * @default 'docs'
+       */
+  outDir?: string;
+  /**
+       * Whether to watch for changes
+       * @default false
+       */
+  watch?: boolean;
+}
+declare function func2md(options?: Func2MdOptions): Plugin;
+//#endregion
+export { Func2MdOptions, func2md as default };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,24 @@
+import { Plugin } from "vite";
+
+//#region src/index.d.ts
+interface Func2MdOptions {
+  /**
+       * Source directory to scan for functions
+       * @default 'src'
+       */
+  srcDir?: string;
+  /**
+       * Output directory for generated markdown files
+       * @default 'docs'
+       */
+  outDir?: string;
+  /**
+       * Whether to watch for changes
+       * @default false
+       */
+  watch?: boolean;
+}
+declare function func2md(options?: Func2MdOptions): Plugin;
+//#endregion
+export { Func2MdOptions, func2md as default };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,175 @@
+import { existsSync, mkdirSync, readFileSync, readdirSync, statSync, writeFileSync } from "fs";
+import { extname, join, resolve } from "path";
+
+//#region src/utils/file-utils.ts
+function findAllFiles(dir, extensions) {
+	let results = [];
+	function traverse(currentDir) {
+		const files = readdirSync(currentDir);
+		for (const file of files) {
+			const filePath = join(currentDir, file);
+			const stat = statSync(filePath);
+			if (stat.isDirectory()) traverse(filePath);
+			else if (stat.isFile() && extensions.includes(extname(file))) results.push(filePath);
+		}
+	}
+	traverse(dir);
+	return results;
+}
+
+//#endregion
+//#region src/utils/jsdoc-parser.ts
+function parseJSDoc(jsdoc) {
+	const lines = jsdoc.trim().split("\n").map((line) => line.replace(/^\s*\*\s?/, ""));
+	const info = {};
+	const titleMatch = lines.find((line) => line.startsWith("@title"));
+	if (titleMatch) info.title = titleMatch.replace("@title", "").trim();
+	else if (lines.length > 0) info.title = lines[0];
+	const descLines = [];
+	for (const line of lines) {
+		if (line.startsWith("@example") || line.startsWith("@param") || line.startsWith("@returns") || line.startsWith("@return")) break;
+		if (!line.startsWith("@title") && line.trim() !== "") descLines.push(line);
+	}
+	if (descLines.length > 0) info.desc = descLines.join(" ").trim();
+	const exampleLines = [];
+	let collectingExample = false;
+	for (const line of lines) {
+		if (line.startsWith("@example")) {
+			collectingExample = true;
+			const exampleContent = line.replace("@example", "").trim();
+			if (exampleContent) exampleLines.push(exampleContent);
+			continue;
+		}
+		if (collectingExample) if (line.startsWith("@")) collectingExample = false;
+		else exampleLines.push(line);
+	}
+	if (exampleLines.length > 0) info.example = exampleLines.join("\n").trim();
+	info.params = [];
+	lines.forEach((line) => {
+		const paramMatch = line.match(/@param\s+{([^}]+)}\s+(\w+)\s+(.+)/);
+		if (paramMatch) info.params.push({
+			name: paramMatch[2],
+			type: paramMatch[1],
+			description: paramMatch[3]
+		});
+	});
+	const returnMatch = lines.find((line) => line.startsWith("@returns") || line.startsWith("@return"));
+	if (returnMatch) {
+		const returnInfo = returnMatch.replace(/@(returns?)/, "").trim();
+		const typeMatch = returnInfo.match(/^{([^}]+)}\s*(.*)/);
+		if (typeMatch) info.returns = {
+			type: typeMatch[1],
+			description: typeMatch[2]
+		};
+		else info.returns = {
+			type: "unknown",
+			description: returnInfo
+		};
+	}
+	return info;
+}
+
+//#endregion
+//#region src/utils/function-extractor.ts
+function extractFunctions(content, filePath) {
+	const functions = [];
+	const functionRegex = new RegExp(String.raw`/\*\*((?:.|\n|\r)*?)\*/\s*(export\s+)?(async\s+)?function\s+(\w+)`, "g");
+	let match;
+	while ((match = functionRegex.exec(content)) !== null) {
+		const [, jsdocRaw, , , functionName] = match;
+		const jsdoc = parseJSDoc(jsdocRaw);
+		functions.push({
+			name: functionName,
+			jsdoc,
+			filePath
+		});
+	}
+	return functions;
+}
+
+//#endregion
+//#region src/generators/markdown-generator.ts
+function generateTitleSection(func) {
+	const { name, jsdoc } = func;
+	return `# ${jsdoc.title || name}\n\n`;
+}
+function generateDescriptionSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.desc) return `## 说明\n\n${jsdoc.desc}\n\n`;
+	return "";
+}
+function generateSignatureSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.signature) return `## 签名\n\n\`\`\`ts\n${jsdoc.signature}\n\`\`\`\n\n`;
+	return "";
+}
+function generateParametersSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.params && jsdoc.params.length > 0) {
+		let section = `## 参数\n\n`;
+		section += `| 参数名 | 类型 | 说明 |\n|--------|------|------|\n`;
+		jsdoc.params.forEach((param) => {
+			section += `| ${param.name} | \`${param.type}\` | ${param.description} |\n`;
+		});
+		section += `\n`;
+		return section;
+	}
+	return "";
+}
+function generateReturnsSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.returns) return `## 返回值\n\n- 类型: \`${jsdoc.returns.type}\`\n- 说明: ${jsdoc.returns.description}\n\n`;
+	return "";
+}
+function generateExampleSection(func) {
+	const { jsdoc } = func;
+	if (jsdoc.example) return `## 示例\n\n\`\`\`ts\n${jsdoc.example}\n\`\`\`\n\n`;
+	return "";
+}
+function generateMarkdown(func) {
+	let md = generateTitleSection(func);
+	md += generateDescriptionSection(func);
+	md += generateSignatureSection(func);
+	md += generateParametersSection(func);
+	md += generateReturnsSection(func);
+	md += generateExampleSection(func);
+	return md;
+}
+
+//#endregion
+//#region src/core/scanner.ts
+async function scanAndGenerateDocs(srcDir, outDir) {
+	console.log(`Scanning ${srcDir} and generating docs to ${outDir}`);
+	const files = findAllFiles(srcDir, [".ts", ".js"]);
+	for (const file of files) {
+		const functions = extractFunctions(readFileSync(file, "utf-8"), file);
+		for (const func of functions) {
+			const mdContent = generateMarkdown(func);
+			const outputPath = join(outDir, `${func.name}.md`);
+			writeFileSync(outputPath, mdContent);
+			console.log(`Generated documentation: ${outputPath}`);
+		}
+	}
+}
+
+//#endregion
+//#region src/index.ts
+function func2md(options = {}) {
+	const { srcDir = "src", outDir = "docs", watch = false } = options;
+	const resolvedSrcDir = resolve(srcDir);
+	const resolvedOutDir = resolve(outDir);
+	return {
+		name: "func2md",
+		async buildStart() {
+			if (!existsSync(resolvedOutDir)) mkdirSync(resolvedOutDir, { recursive: true });
+			await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir);
+		},
+		async handleHotUpdate(ctx) {
+			if (watch && ctx.file.includes(resolvedSrcDir)) await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir);
+		}
+	};
+}
+
+//#endregion
+export { func2md as default };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/utils/file-utils.ts","../src/utils/jsdoc-parser.ts","../src/utils/function-extractor.ts","../src/generators/markdown-generator.ts","../src/core/scanner.ts","../src/index.ts"],"sourcesContent":["import { readdirSync, statSync } from 'fs'\nimport { join, extname } from 'path'\n\nexport function findAllFiles(dir: string, extensions: string[]): string[] {\n  let results: string[] = []\n  \n  function traverse(currentDir: string) {\n    const files = readdirSync(currentDir)\n    \n    for (const file of files) {\n      const filePath = join(currentDir, file)\n      const stat = statSync(filePath)\n      \n      if (stat.isDirectory()) {\n        traverse(filePath)\n      } else if (stat.isFile() && extensions.includes(extname(file))) {\n        results.push(filePath)\n      }\n    }\n  }\n  \n  traverse(dir)\n  return results\n}","export interface JSDocInfo {\n  title?: string\n  desc?: string\n  example?: string\n  params?: Array<{\n    name: string\n    type: string\n    description: string\n  }>\n  returns?: {\n    type: string\n    description: string\n  }\n  signature?: string\n}\n\nexport function parseJSDoc(jsdoc: string): JSDocInfo {\n  const lines = jsdoc.trim().split('\\n').map(line => line.replace(/^\\s*\\*\\s?/, ''))\n  \n  const info: JSDocInfo = {}\n  \n  // Extract title (first line or @title tag)\n  const titleMatch = lines.find(line => line.startsWith('@title'))\n  if (titleMatch) {\n    info.title = titleMatch.replace('@title', '').trim()\n  } else if (lines.length > 0) {\n    info.title = lines[0]\n  }\n  \n  // Extract description - all lines that don't start with @\n  const descLines: string[] = []\n  let inExample = false\n  for (const line of lines) {\n    // Stop collecting description when we hit @example or @param or @returns\n    if (line.startsWith('@example') || line.startsWith('@param') || line.startsWith('@returns') || line.startsWith('@return')) {\n      break\n    }\n    \n    // Only add non-empty lines that don't start with @title to description\n    if (!line.startsWith('@title') && line.trim() !== '') {\n      descLines.push(line)\n    }\n  }\n  \n  if (descLines.length > 0) {\n    info.desc = descLines.join(' ').trim()\n  }\n  \n  // Extract example\n  const exampleLines: string[] = []\n  let collectingExample = false\n  for (const line of lines) {\n    if (line.startsWith('@example')) {\n      collectingExample = true\n      const exampleContent = line.replace('@example', '').trim()\n      if (exampleContent) {\n        exampleLines.push(exampleContent)\n      }\n      continue\n    }\n    \n    // Continue collecting example lines until we hit another tag\n    if (collectingExample) {\n      if (line.startsWith('@')) {\n        collectingExample = false\n      } else {\n        exampleLines.push(line)\n      }\n    }\n  }\n  \n  if (exampleLines.length > 0) {\n    info.example = exampleLines.join('\\n').trim()\n  }\n  \n  // Extract parameters\n  info.params = []\n  lines.forEach(line => {\n    const paramMatch = line.match(/@param\\s+{([^}]+)}\\s+(\\w+)\\s+(.+)/)\n    if (paramMatch) {\n      info.params!.push({\n        name: paramMatch[2],\n        type: paramMatch[1],\n        description: paramMatch[3]\n      })\n    }\n  })\n  \n  // Extract return value\n  const returnMatch = lines.find(line => line.startsWith('@returns') || line.startsWith('@return'))\n  if (returnMatch) {\n    const returnInfo = returnMatch.replace(/@(returns?)/, '').trim()\n    const typeMatch = returnInfo.match(/^{([^}]+)}\\s*(.*)/)\n    if (typeMatch) {\n      info.returns = {\n        type: typeMatch[1],\n        description: typeMatch[2]\n      }\n    } else {\n      info.returns = {\n        type: 'unknown',\n        description: returnInfo\n      }\n    }\n  }\n  \n  return info\n}","import { parseJSDoc, JSDocInfo } from './jsdoc-parser'\n\nexport interface FunctionInfo {\n  name: string\n  jsdoc: JSDocInfo\n  signature?: string\n  filePath: string\n}\n\nexport function extractFunctions(content: string, filePath: string): FunctionInfo[] {\n  // This is a simplified implementation\n  // In a real implementation, we would use AST parsing (e.g., with TypeScript Compiler API)\n  \n  const functions: FunctionInfo[] = []\n  \n  // Match function declarations with JSDoc comments\n  // Using a string to avoid regex escaping issues\n  const functionRegex = new RegExp(\n    String.raw`/\\*\\*((?:.|\\n|\\r)*?)\\*/\\s*(export\\s+)?(async\\s+)?function\\s+(\\w+)`,\n    'g'\n  )\n  let match\n  \n  while ((match = functionRegex.exec(content)) !== null) {\n    const [, jsdocRaw, , , functionName] = match\n    const jsdoc = parseJSDoc(jsdocRaw)\n    \n    functions.push({\n      name: functionName,\n      jsdoc,\n      filePath\n    })\n  }\n  \n  return functions\n}","import { FunctionInfo } from '../utils/function-extractor'\n\n// Generate the main title section\nexport function generateTitleSection(func: FunctionInfo): string {\n  const { name, jsdoc } = func\n  const title = jsdoc.title || name\n  return `# ${title}\\n\\n`\n}\n\n// Generate the description section\nexport function generateDescriptionSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.desc) {\n    return `## 说明\\n\\n${jsdoc.desc}\\n\\n`\n  }\n  return ''\n}\n\n// Generate the signature section\nexport function generateSignatureSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.signature) {\n    return `## 签名\\n\\n\\`\\`\\`ts\\n${jsdoc.signature}\\n\\`\\`\\`\\n\\n`\n  }\n  return ''\n}\n\n// Generate the parameters section\nexport function generateParametersSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.params && jsdoc.params.length > 0) {\n    let section = `## 参数\\n\\n`\n    section += `| 参数名 | 类型 | 说明 |\\n|--------|------|------|\\n`\n    jsdoc.params.forEach(param => {\n      section += `| ${param.name} | \\`${param.type}\\` | ${param.description} |\\n`\n    })\n    section += `\\n`\n    return section\n  }\n  return ''\n}\n\n// Generate the returns section\nexport function generateReturnsSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.returns) {\n    return `## 返回值\\n\\n- 类型: \\`${jsdoc.returns.type}\\`\\n- 说明: ${jsdoc.returns.description}\\n\\n`\n  }\n  return ''\n}\n\n// Generate the example section\nexport function generateExampleSection(func: FunctionInfo): string {\n  const { jsdoc } = func\n  if (jsdoc.example) {\n    return `## 示例\\n\\n\\`\\`\\`ts\\n${jsdoc.example}\\n\\`\\`\\`\\n\\n`\n  }\n  return ''\n}\n\n// Main function to generate markdown content\nexport function generateMarkdown(func: FunctionInfo): string {\n  let md = generateTitleSection(func)\n  md += generateDescriptionSection(func)\n  md += generateSignatureSection(func)\n  md += generateParametersSection(func)\n  md += generateReturnsSection(func)\n  md += generateExampleSection(func)\n  return md\n}","import { readFileSync, writeFileSync } from 'fs'\nimport { join } from 'path'\nimport { findAllFiles } from '../utils/file-utils'\nimport { extractFunctions } from '../utils/function-extractor'\nimport { generateMarkdown } from '../generators/markdown-generator'\n\nexport async function scanAndGenerateDocs(srcDir: string, outDir: string) {\n  console.log(`Scanning ${srcDir} and generating docs to ${outDir}`)\n  \n  // Find all .ts and .js files in srcDir\n  const files = findAllFiles(srcDir, ['.ts', '.js'])\n  \n  for (const file of files) {\n    const content = readFileSync(file, 'utf-8')\n    const functions = extractFunctions(content, file)\n    \n    for (const func of functions) {\n      const mdContent = generateMarkdown(func)\n      const outputPath = join(outDir, `${func.name}.md`)\n      writeFileSync(outputPath, mdContent)\n      console.log(`Generated documentation: ${outputPath}`)\n    }\n  }\n}","import type { Plugin } from 'vite'\nimport { existsSync, mkdirSync } from 'fs'\nimport { resolve } from 'path'\nimport { scanAndGenerateDocs } from './core/scanner'\n\nexport interface Func2MdOptions {\n  /**\n   * Source directory to scan for functions\n   * @default 'src'\n   */\n  srcDir?: string\n  \n  /**\n   * Output directory for generated markdown files\n   * @default 'docs'\n   */\n  outDir?: string\n  \n  /**\n   * Whether to watch for changes\n   * @default false\n   */\n  watch?: boolean\n}\n\nexport default function func2md(options: Func2MdOptions = {}): Plugin {\n  const { \n    srcDir = 'src', \n    outDir = 'docs',\n    watch = false\n  } = options\n  \n  const resolvedSrcDir = resolve(srcDir)\n  const resolvedOutDir = resolve(outDir)\n  \n  return {\n    name: 'func2md',\n    \n    async buildStart() {\n      if (!existsSync(resolvedOutDir)) {\n        mkdirSync(resolvedOutDir, { recursive: true })\n      }\n      \n      // Scan files and generate docs\n      await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir)\n    },\n    \n    async handleHotUpdate(ctx) {\n      if (watch && ctx.file.includes(resolvedSrcDir)) {\n        await scanAndGenerateDocs(resolvedSrcDir, resolvedOutDir)\n      }\n    }\n  }\n}"],"mappings":";;;;AAGA,SAAgB,aAAa,KAAa,YAAgC;CACxE,IAAI,UAAoB,EAAE;CAE1B,SAAS,SAAS,YAAoB;EACpC,MAAM,QAAQ,YAAY,WAAW;AAErC,OAAK,MAAM,QAAQ,OAAO;GACxB,MAAM,WAAW,KAAK,YAAY,KAAK;GACvC,MAAM,OAAO,SAAS,SAAS;AAE/B,OAAI,KAAK,aAAa,CACpB,UAAS,SAAS;YACT,KAAK,QAAQ,IAAI,WAAW,SAAS,QAAQ,KAAK,CAAC,CAC5D,SAAQ,KAAK,SAAS;;;AAK5B,UAAS,IAAI;AACb,QAAO;;;;;ACNT,SAAgB,WAAW,OAA0B;CACnD,MAAM,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,KAAI,SAAQ,KAAK,QAAQ,aAAa,GAAG,CAAC;CAEjF,MAAM,OAAkB,EAAE;CAG1B,MAAM,aAAa,MAAM,MAAK,SAAQ,KAAK,WAAW,SAAS,CAAC;AAChE,KAAI,WACF,MAAK,QAAQ,WAAW,QAAQ,UAAU,GAAG,CAAC,MAAM;UAC3C,MAAM,SAAS,EACxB,MAAK,QAAQ,MAAM;CAIrB,MAAM,YAAsB,EAAE;AAE9B,MAAK,MAAM,QAAQ,OAAO;AAExB,MAAI,KAAK,WAAW,WAAW,IAAI,KAAK,WAAW,SAAS,IAAI,KAAK,WAAW,WAAW,IAAI,KAAK,WAAW,UAAU,CACvH;AAIF,MAAI,CAAC,KAAK,WAAW,SAAS,IAAI,KAAK,MAAM,KAAK,GAChD,WAAU,KAAK,KAAK;;AAIxB,KAAI,UAAU,SAAS,EACrB,MAAK,OAAO,UAAU,KAAK,IAAI,CAAC,MAAM;CAIxC,MAAM,eAAyB,EAAE;CACjC,IAAI,oBAAoB;AACxB,MAAK,MAAM,QAAQ,OAAO;AACxB,MAAI,KAAK,WAAW,WAAW,EAAE;AAC/B,uBAAoB;GACpB,MAAM,iBAAiB,KAAK,QAAQ,YAAY,GAAG,CAAC,MAAM;AAC1D,OAAI,eACF,cAAa,KAAK,eAAe;AAEnC;;AAIF,MAAI,kBACF,KAAI,KAAK,WAAW,IAAI,CACtB,qBAAoB;MAEpB,cAAa,KAAK,KAAK;;AAK7B,KAAI,aAAa,SAAS,EACxB,MAAK,UAAU,aAAa,KAAK,KAAK,CAAC,MAAM;AAI/C,MAAK,SAAS,EAAE;AAChB,OAAM,SAAQ,SAAQ;EACpB,MAAM,aAAa,KAAK,MAAM,oCAAoC;AAClE,MAAI,WACF,MAAK,OAAQ,KAAK;GAChB,MAAM,WAAW;GACjB,MAAM,WAAW;GACjB,aAAa,WAAW;GACzB,CAAC;GAEJ;CAGF,MAAM,cAAc,MAAM,MAAK,SAAQ,KAAK,WAAW,WAAW,IAAI,KAAK,WAAW,UAAU,CAAC;AACjG,KAAI,aAAa;EACf,MAAM,aAAa,YAAY,QAAQ,eAAe,GAAG,CAAC,MAAM;EAChE,MAAM,YAAY,WAAW,MAAM,oBAAoB;AACvD,MAAI,UACF,MAAK,UAAU;GACb,MAAM,UAAU;GAChB,aAAa,UAAU;GACxB;MAED,MAAK,UAAU;GACb,MAAM;GACN,aAAa;GACd;;AAIL,QAAO;;;;;ACjGT,SAAgB,iBAAiB,SAAiB,UAAkC;CAIlF,MAAM,YAA4B,EAAE;CAIpC,MAAM,gBAAgB,IAAI,OACxB,OAAO,GAAG,qEACV,IACD;CACD,IAAI;AAEJ,SAAQ,QAAQ,cAAc,KAAK,QAAQ,MAAM,MAAM;EACrD,MAAM,GAAG,cAAc,gBAAgB;EACvC,MAAM,QAAQ,WAAW,SAAS;AAElC,YAAU,KAAK;GACb,MAAM;GACN;GACA;GACD,CAAC;;AAGJ,QAAO;;;;;AC/BT,SAAgB,qBAAqB,MAA4B;CAC/D,MAAM,EAAE,MAAM,UAAU;AAExB,QAAO,KADO,MAAM,SAAS,KACX;;AAIpB,SAAgB,2BAA2B,MAA4B;CACrE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,KACR,QAAO,YAAY,MAAM,KAAK;AAEhC,QAAO;;AAIT,SAAgB,yBAAyB,MAA4B;CACnE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,UACR,QAAO,sBAAsB,MAAM,UAAU;AAE/C,QAAO;;AAIT,SAAgB,0BAA0B,MAA4B;CACpE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,UAAU,MAAM,OAAO,SAAS,GAAG;EAC3C,IAAI,UAAU;AACd,aAAW;AACX,QAAM,OAAO,SAAQ,UAAS;AAC5B,cAAW,KAAK,MAAM,KAAK,OAAO,MAAM,KAAK,OAAO,MAAM,YAAY;IACtE;AACF,aAAW;AACX,SAAO;;AAET,QAAO;;AAIT,SAAgB,uBAAuB,MAA4B;CACjE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,QACR,QAAO,qBAAqB,MAAM,QAAQ,KAAK,YAAY,MAAM,QAAQ,YAAY;AAEvF,QAAO;;AAIT,SAAgB,uBAAuB,MAA4B;CACjE,MAAM,EAAE,UAAU;AAClB,KAAI,MAAM,QACR,QAAO,sBAAsB,MAAM,QAAQ;AAE7C,QAAO;;AAIT,SAAgB,iBAAiB,MAA4B;CAC3D,IAAI,KAAK,qBAAqB,KAAK;AACnC,OAAM,2BAA2B,KAAK;AACtC,OAAM,yBAAyB,KAAK;AACpC,OAAM,0BAA0B,KAAK;AACrC,OAAM,uBAAuB,KAAK;AAClC,OAAM,uBAAuB,KAAK;AAClC,QAAO;;;;;AC9DT,eAAsB,oBAAoB,QAAgB,QAAgB;AACxE,SAAQ,IAAI,YAAY,OAAO,0BAA0B,SAAS;CAGlE,MAAM,QAAQ,aAAa,QAAQ,CAAC,OAAO,MAAM,CAAC;AAElD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,YAAY,iBADF,aAAa,MAAM,QAAQ,EACC,KAAK;AAEjD,OAAK,MAAM,QAAQ,WAAW;GAC5B,MAAM,YAAY,iBAAiB,KAAK;GACxC,MAAM,aAAa,KAAK,QAAQ,GAAG,KAAK,KAAK,KAAK;AAClD,iBAAc,YAAY,UAAU;AACpC,WAAQ,IAAI,4BAA4B,aAAa;;;;;;;ACK3D,SAAwB,QAAQ,UAA0B,EAAE,EAAU;CACpE,MAAM,EACJ,SAAS,OACT,SAAS,QACT,QAAQ,UACN;CAEJ,MAAM,iBAAiB,QAAQ,OAAO;CACtC,MAAM,iBAAiB,QAAQ,OAAO;AAEtC,QAAO;EACL,MAAM;EAEN,MAAM,aAAa;AACjB,OAAI,CAAC,WAAW,eAAe,CAC7B,WAAU,gBAAgB,EAAE,WAAW,MAAM,CAAC;AAIhD,SAAM,oBAAoB,gBAAgB,eAAe;;EAG3D,MAAM,gBAAgB,KAAK;AACzB,OAAI,SAAS,IAAI,KAAK,SAAS,eAAe,CAC5C,OAAM,oBAAoB,gBAAgB,eAAe;;EAG9D"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "func2md",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "A Vite plugin to generate VitePress documentation from JSDoc and TypeScript types",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsdown 2>&1 | grep -v '\\[38;5;2' | grep -v 'MISSING_EXPORT' | grep -v 'Missing export' | grep -v 'IMPORT_IS_UNDEFINED' | grep -v 'will always be undefined' | grep -v '^\\s*$'",
+    "dev": "tsdown --watch",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "example:dev": "cd example && npm run dev",
+    "example:build": "cd example && npm run build"
+  },
+  "keywords": [
+    "vite",
+    "vitepress",
+    "documentation",
+    "jsdoc",
+    "typescript"
+  ],
+  "author": "Azir-11",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Vectutil/func2md.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Vectutil/func2md/issues"
+  },
+  "homepage": "https://github.com/Vectutil/func2md#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "vite": ">=5"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.10",
+    "postcss": "^8.5.6",
+    "tsdown": "0.20.0-beta.3",
+    "typescript": "^5.9.2",
+    "vite": "^6.0.5",
+    "vitepress": "^1.5.0",
+    "vitest": "^3.0.4"
+  },
+  "dependencies": {
+    "jsdoc": "^4.0.4"
+  }
+}