@chnak/zod-to-markdown 1.0.2 → 1.0.3

package/README.md

@@ -1,6 +1,6 @@
 # zod-to-markdown
 
-将 Zod schema 转换为 Markdown 文档的工具函数。
+将 Zod schema 转换为 Markdown 文档的工具函数，支持两种输出格式：树状列表和表格。
 
 ## 安装
 
@@ -13,7 +13,7 @@ npm install @chnak/zod-to-markdown
 ### ESM / TypeScript
 
 ```typescript
-import { zodSchemaToMarkdown } from '@chnak/zod-to-markdown';
+import { zodSchemaToMarkdown, zodSchemaToTable } from '@chnak/zod-to-markdown';
 import { z } from 'zod';
 
 const schema = z.object({
@@ -21,14 +21,19 @@ const schema = z.object({
   age: z.number(),
 });
 
+// 树状格式
 const markdown = zodSchemaToMarkdown(schema);
 console.log(markdown);
+
+// 表格格式
+const table = zodSchemaToTable(schema);
+console.log(table);
 ```
 
 ### CommonJS / Node.js
 
 ```javascript
-const { zodSchemaToMarkdown } = require('@chnak/zod-to-markdown');
+const { zodSchemaToMarkdown, zodSchemaToTable } = require('@chnak/zod-to-markdown');
 const { z } = require('zod');
 
 const schema = z.object({
@@ -37,11 +42,15 @@ const schema = z.object({
 });
 
 const markdown = zodSchemaToMarkdown(schema);
+const table = zodSchemaToTable(schema);
 console.log(markdown);
+console.log(table);
 ```
 
 ### 输出结果
 
+**树状格式 (`zodSchemaToMarkdown`)**：
+
 ```markdown
 - name
   - String
@@ -49,6 +58,15 @@ console.log(markdown);
   - Number
 ```
 
+**表格格式 (`zodSchemaToTable`)**：
+
+```markdown
+| 字段 | 类型 | 描述 |
+|------|------|------|
+| name | String | - |
+| age | Number | - |
+```
+
 ## 支持的 Zod 类型
 
 ### 基础类型
@@ -161,6 +179,49 @@ console.log(zodSchemaToMarkdown(transformedSchema));
   - String
 ```
 
+### 表格格式示例
+
+```typescript
+import { z } from 'zod';
+
+const userSchema = z.object({
+  id: z.string().uuid().describe('用户ID'),
+  name: z.string().describe('姓名'),
+  profile: z.object({
+    bio: z.string().describe('个人简介'),
+    avatar: z.string().describe('头像URL'),
+  }).describe('用户资料'),
+  tags: z.array(z.string()).describe('标签'),
+  skills: z.record(z.string(), z.number()).describe('技能评分'),
+});
+
+console.log(zodSchemaToTable(userSchema));
+```
+
+输出：
+```markdown
+| 字段 | 类型 | 描述 |
+|------|------|------|
+| id | String | 用户ID |
+| name | String | 姓名 |
+| profile.bio | String | 个人简介 |
+| profile.avatar | String | 头像URL |
+| tags[] | Array<String> | 标签 |
+| skills | Record<String, Number> | 技能评分 |
+```
+
+### 路径格式说明
+
+表格格式使用点 `.` 和 `[]` 表示嵌套结构：
+
+| 格式 | 含义 | 示例 |
+|------|------|------|
+| `field` | 普通字段 | `name` |
+| `parent.child` | 对象嵌套 | `profile.bio` |
+| `field[]` | 数组 | `tags[]` |
+| `array[].field` | 对象数组的字段 | `users[].name` |
+| `a[].b[].c` | 多层嵌套 | `departments[].employees[].name` |
+
 ## API
 
 ### `zodSchemaToMarkdown(schema, indentLevel?)`
@@ -170,7 +231,15 @@ console.log(zodSchemaToMarkdown(transformedSchema));
 | `schema` | `z.ZodTypeAny` | 要转换的 Zod schema |
 | `indentLevel` | `number` | 初始缩进级别（默认: `0`） |
 
-返回转换后的 Markdown 字符串。
+返回树状格式的 Markdown 字符串。
+
+### `zodSchemaToTable(schema)`
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| `schema` | `z.ZodTypeAny` | 要转换的 Zod schema（仅支持 ZodObject） |
+
+返回表格格式的 Markdown 字符串。非 ZodObject 类型会回退到树状格式。
 
 ## License
 

package/examples/company-schema-table.md

@@ -2,17 +2,17 @@
 |------|------|------|
 | id | String | 公司ID |
 | name | String | 公司名称 |
-| departments[] | name | 部门名称 |
-| departments[] | employees[] | 员工ID |
-| departments[] | employees[] | 姓名 |
-| departments[] | employees[] | 职位 |
-| departments[] | employees[] | 技能 |
-| departments[] | employees[] | 邮箱 |
-| departments[] | employees[] | 电话 |
-| departments[] | location.street | 街道 |
-| departments[] | location.city | 城市 |
-| departments[] | location.country | 国家 |
-| departments[] | location.coordinates.lat | 纬度 |
-| departments[] | location.coordinates.lng | 经度 |
+| departments[].name | String | 部门名称 |
+| departments[].employees[].id | String | 员工ID |
+| departments[].employees[].name | String | 姓名 |
+| departments[].employees[].title | String | 职位 |
+| departments[].employees[].skills[] | Array<String> | 技能 |
+| departments[].employees[].contact.email | String | 邮箱 |
+| departments[].employees[].contact.phone | Optional<String> | 电话 |
+| departments[].location.street | String | 街道 |
+| departments[].location.city | String | 城市 |
+| departments[].location.country | String | 国家 |
+| departments[].location.coordinates.lat | Number | 纬度 |
+| departments[].location.coordinates.lng | Number | 经度 |
 | foundedYear | Number | 成立年份 |
 | tags[] | Array<String> | 标签 |

package/lib/index.js

@@ -72,9 +72,10 @@ function collectFields(schema, prefix, fields) {
             const innerFields = [];
             collectFields(element, '', innerFields);
             innerFields.forEach(field => {
+                const fieldPath = field.path || 'value';
                 fields.push({
-                    path: `${prefix}[]`,
-                    type: field.path || getTypeString(element),
+                    path: `${prefix}[].${fieldPath}`,
+                    type: field.type,
                     description: field.description,
                 });
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chnak/zod-to-markdown",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A utility function to convert Zod schemas to Markdown documentation",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",