@chnak/zod-to-markdown 1.0.2 → 1.0.4

package/examples/complex-types.md

@@ -1,152 +1,152 @@
-# Zod to Markdown - Complex Types Examples
-
-This document demonstrates the `zodSchemaToMarkdown` function's support for complex Zod types used in OpenAI API schemas.
-
-## ZodEffects (Transform)
-
-```typescript
-const schema = z.string().transform(val => val.length);
-```
-
-Output:
-```markdown
-- Effects (transform)
-  - String
-```
-
-## ZodDiscriminatedUnion
-
-```typescript
-const schema = z.discriminatedUnion('type', [
-  z.object({ type: z.literal('a'), a: z.string() }),
-  z.object({ type: z.literal('b'), b: z.number() })
-]);
-```
-
-Output:
-```markdown
-- DiscriminatedUnion (key: type)
-  - type
-    - Literal: "a"
-  - a
-    - String
-  |
-  - type
-    - Literal: "b"
-  - b
-    - Number
-```
-
-## ZodIntersection
-
-```typescript
-const schema = z.object({ a: z.string() }).and(z.object({ b: z.number() }));
-```
-
-Output:
-```markdown
-- Intersection
-  Left:
-    - a
-      - String
-  Right:
-    - b
-      - Number
-```
-
-## ZodRecord
-
-```typescript
-const schema = z.record(z.string(), z.number());
-```
-
-Output:
-```markdown
-- Record
-  Key:
-    - String
-  Value:
-    - Number
-```
-
-## ZodTuple
-
-```typescript
-const schema = z.tuple([z.string(), z.number()]);
-```
-
-Output:
-```markdown
-- Tuple
-  [0]:
-    - String
-  [1]:
-    - Number
-```
-
-## ZodLiteral
-
-```typescript
-const schema = z.literal('hello');
-```
-
-Output:
-```markdown
-- Literal: "hello"
-```
-
-## Primitive Types
-
-### ZodBigInt
-```typescript
-z.bigint()
-```
-Output:
-```markdown
-- BigInt
-```
-
-### ZodDate
-```typescript
-z.date()
-```
-Output:
-```markdown
-- Date
-```
-
-### ZodNaN
-```typescript
-z.nan()
-```
-Output:
-```markdown
-- NaN
-```
-
-### ZodNever
-```typescript
-z.never()
-```
-Output:
-```markdown
-- Never
-```
-
-### ZodUnknown
-```typescript
-z.unknown()
-```
-Output:
-```markdown
-- Unknown
-```
-
-### ZodVoid
-```typescript
-z.void()
-```
-Output:
-```markdown
-- Void
-```
+# Zod to Markdown - Complex Types Examples
+
+This document demonstrates the `zodSchemaToMarkdown` function's support for complex Zod types used in OpenAI API schemas.
+
+## ZodEffects (Transform)
+
+```typescript
+const schema = z.string().transform(val => val.length);
+```
+
+Output:
+```markdown
+- Effects (transform)
+  - String
+```
+
+## ZodDiscriminatedUnion
+
+```typescript
+const schema = z.discriminatedUnion('type', [
+  z.object({ type: z.literal('a'), a: z.string() }),
+  z.object({ type: z.literal('b'), b: z.number() })
+]);
+```
+
+Output:
+```markdown
+- DiscriminatedUnion (key: type)
+  - type
+    - Literal: "a"
+  - a
+    - String
+  |
+  - type
+    - Literal: "b"
+  - b
+    - Number
+```
+
+## ZodIntersection
+
+```typescript
+const schema = z.object({ a: z.string() }).and(z.object({ b: z.number() }));
+```
+
+Output:
+```markdown
+- Intersection
+  Left:
+    - a
+      - String
+  Right:
+    - b
+      - Number
+```
+
+## ZodRecord
+
+```typescript
+const schema = z.record(z.string(), z.number());
+```
+
+Output:
+```markdown
+- Record
+  Key:
+    - String
+  Value:
+    - Number
+```
+
+## ZodTuple
+
+```typescript
+const schema = z.tuple([z.string(), z.number()]);
+```
+
+Output:
+```markdown
+- Tuple
+  [0]:
+    - String
+  [1]:
+    - Number
+```
+
+## ZodLiteral
+
+```typescript
+const schema = z.literal('hello');
+```
+
+Output:
+```markdown
+- Literal: "hello"
+```
+
+## Primitive Types
+
+### ZodBigInt
+```typescript
+z.bigint()
+```
+Output:
+```markdown
+- BigInt
+```
+
+### ZodDate
+```typescript
+z.date()
+```
+Output:
+```markdown
+- Date
+```
+
+### ZodNaN
+```typescript
+z.nan()
+```
+Output:
+```markdown
+- NaN
+```
+
+### ZodNever
+```typescript
+z.never()
+```
+Output:
+```markdown
+- Never
+```
+
+### ZodUnknown
+```typescript
+z.unknown()
+```
+Output:
+```markdown
+- Unknown
+```
+
+### ZodVoid
+```typescript
+z.void()
+```
+Output:
+```markdown
+- Void
+```

package/examples/nested-object-example.ts

@@ -1,42 +1,42 @@
-import { z } from 'zod';
-import { zodSchemaToTable } from '../src/index';
-import * as fs from 'fs';
-
-// 纯对象嵌套示例
-const coordinatesSchema = z.object({
-  lat: z.number().describe('纬度'),
-  lng: z.number().describe('经度'),
-});
-
-const addressSchema = z.object({
-  street: z.string().describe('街道'),
-  city: z.string().describe('城市'),
-  country: z.string().describe('国家'),
-  coordinates: coordinatesSchema.describe('坐标'),
-});
-
-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'),
-    age: z.number().describe('年龄'),
-  }).describe('用户资料'),
-  settings: z.object({
-    theme: z.enum(['light', 'dark']).describe('主题'),
-    language: z.string().describe('语言'),
-    notifications: z.object({
-      email: z.boolean().describe('邮件通知'),
-      push: z.boolean().describe('推送通知'),
-    }).describe('通知设置'),
-  }).describe('设置'),
-});
-
-const markdown = zodSchemaToTable(userSchema);
-
-console.log('## User Schema (Object 嵌套)\n');
-console.log(markdown);
-
-fs.writeFileSync('examples/nested-object-example.md', markdown);
-console.log('已保存到 examples/nested-object-example.md');
+import { z } from 'zod';
+import { zodSchemaToTable } from '../src/index';
+import * as fs from 'fs';
+
+// 纯对象嵌套示例
+const coordinatesSchema = z.object({
+  lat: z.number().describe('纬度'),
+  lng: z.number().describe('经度'),
+});
+
+const addressSchema = z.object({
+  street: z.string().describe('街道'),
+  city: z.string().describe('城市'),
+  country: z.string().describe('国家'),
+  coordinates: coordinatesSchema.describe('坐标'),
+});
+
+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'),
+    age: z.number().describe('年龄'),
+  }).describe('用户资料'),
+  settings: z.object({
+    theme: z.enum(['light', 'dark']).describe('主题'),
+    language: z.string().describe('语言'),
+    notifications: z.object({
+      email: z.boolean().describe('邮件通知'),
+      push: z.boolean().describe('推送通知'),
+    }).describe('通知设置'),
+  }).describe('设置'),
+});
+
+const markdown = zodSchemaToTable(userSchema);
+
+console.log('## User Schema (Object 嵌套)\n');
+console.log(markdown);
+
+fs.writeFileSync('examples/nested-object-example.md', markdown);
+console.log('已保存到 examples/nested-object-example.md');