sizuku 0.4.1 → 0.5.0

package/README.md

@@ -2,7 +2,7 @@
 
 # Sizuku
 
-**[Sizuku](https://www.npmjs.com/package/sizuku)** is a tool that generates validation schemas for Zod and Valibot, as well as ER diagrams, from [Drizzle](https://orm.drizzle.team/) schemas annotated with comments.
+**[Sizuku](https://www.npmjs.com/package/sizuku)** is a tool that generates validation schemas for Zod, Valibot, ArkType, and Effect Schema, as well as ER diagrams, from [Drizzle](https://orm.drizzle.team/) schemas.
 
 ## Features
 
@@ -12,8 +12,7 @@
 - ⚡ Automatically generates [Effect Schema](https://effect.website/docs/schema/introduction/) from your Drizzle schema
 - 📊 Creates [Mermaid](https://mermaid.js.org/) ER diagrams
 - 📝 Generates [DBML](https://dbml.dbdiagram.io/) (Database Markup Language) files
-- 🖼️ Outputs ER diagrams as **PNG/SVG** images using [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer)
-
+- 🖼️ Outputs ER diagrams as **PNG** images using [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer)
 
 ## Getting Started
 
@@ -37,10 +36,14 @@ export const user = mysqlTable('user', {
   /// Primary key
   /// @z.uuid()
   /// @v.pipe(v.string(), v.uuid())
+  /// @a."string.uuid"
+  /// @e.Schema.UUID
   id: varchar('id', { length: 36 }).primaryKey(),
   /// Display name
   /// @z.string().min(1).max(50)
   /// @v.pipe(v.string(), v.minLength(1), v.maxLength(50))
+  /// @a."1 <= string <= 50"
+  /// @e.Schema.String.pipe(Schema.minLength(1), Schema.maxLength(50))
   name: varchar('name', { length: 50 }).notNull(),
 })
 
@@ -49,18 +52,26 @@ export const post = mysqlTable('post', {
   /// Primary key
   /// @z.uuid()
   /// @v.pipe(v.string(), v.uuid())
+  /// @a."string.uuid"
+  /// @e.Schema.UUID
   id: varchar('id', { length: 36 }).primaryKey(),
   /// Article title
   /// @z.string().min(1).max(100)
   /// @v.pipe(v.string(), v.minLength(1), v.maxLength(100))
+  /// @a."1 <= string <= 100"
+  /// @e.Schema.String.pipe(Schema.minLength(1), Schema.maxLength(100))
   title: varchar('title', { length: 100 }).notNull(),
   /// Body content (no length limit)
   /// @z.string().min(1).max(65535)
   /// @v.pipe(v.string(), v.minLength(1), v.maxLength(65535))
+  /// @a."1 <= string <= 65535"
+  /// @e.Schema.String.pipe(Schema.minLength(1), Schema.maxLength(65535))
   content: varchar('content', { length: 65535 }).notNull(),
   /// Foreign key referencing User.id
   /// @z.uuid()
   /// @v.pipe(v.string(), v.uuid())
+  /// @a."string.uuid"
+  /// @e.Schema.UUID
   userId: varchar('user_id', { length: 36 }).notNull(),
 })
 
@@ -100,21 +111,19 @@ export default defineConfig({
     output: 'arktype/index.ts',
     comment: true,
     type: true,
+    relation: true,
   },
   effect: {
     output: 'effect/index.ts',
     comment: true,
     type: true,
+    relation: true,
   },
   mermaid: {
     output: 'mermaid-er/ER.md',
   },
   dbml: {
-    output: 'dbml/schema.dbml',
-  },
-  svg: {
-    output: 'docs/er-diagram.png',
-    format: 'png',
+    output: 'docs/schema.dbml',
   },
 })
 ```
@@ -125,6 +134,16 @@ Run Sizuku:
 npx sizuku
 ```
 
+Output:
+```
+💧 Generated Zod schema at: zod/index.ts
+💧 Generated Valibot schema at: valibot/index.ts
+💧 Generated ArkType schema at: arktype/index.ts
+💧 Generated Effect schema at: effect/index.ts
+💧 Generated Mermaid ER at: mermaid-er/ER.md
+💧 Generated DBML at: docs/schema.dbml
+```
+
 ### Zod
 
 ```ts
@@ -221,6 +240,62 @@ export const PostRelationsSchema = v.object({ ...PostSchema.entries, user: UserS
 export type PostRelations = v.InferInput<typeof PostRelationsSchema>
 ```
 
+### ArkType
+
+```ts
+import { type } from 'arktype'
+
+export const UserSchema = type({
+  /** Primary key */
+  id: 'string.uuid',
+  /** Display name */
+  name: '1 <= string <= 50',
+})
+
+export type User = typeof UserSchema.infer
+
+export const PostSchema = type({
+  /** Primary key */
+  id: 'string.uuid',
+  /** Article title */
+  title: '1 <= string <= 100',
+  /** Body content (no length limit) */
+  content: '1 <= string <= 65535',
+  /** Foreign key referencing User.id */
+  userId: 'string.uuid',
+})
+
+export type Post = typeof PostSchema.infer
+```
+
+### Effect Schema
+
+```ts
+import { Schema } from 'effect'
+
+export const UserSchema = Schema.Struct({
+  /** Primary key */
+  id: Schema.UUID,
+  /** Display name */
+  name: Schema.String.pipe(Schema.minLength(1), Schema.maxLength(50)),
+})
+
+export type User = Schema.Schema.Type<typeof UserSchema>
+
+export const PostSchema = Schema.Struct({
+  /** Primary key */
+  id: Schema.UUID,
+  /** Article title */
+  title: Schema.String.pipe(Schema.minLength(1), Schema.maxLength(100)),
+  /** Body content (no length limit) */
+  content: Schema.String.pipe(Schema.minLength(1), Schema.maxLength(65535)),
+  /** Foreign key referencing User.id */
+  userId: Schema.UUID,
+})
+
+export type Post = Schema.Schema.Type<typeof PostSchema>
+```
+
 ### Mermaid ER
 
 ```mermaid
@@ -240,6 +315,11 @@ erDiagram
 
 ### DBML
 
+The `dbml` generator outputs a DBML schema file or ER diagram PNG depending on the file extension:
+
+- `.dbml` extension: outputs a DBML schema file
+- `.png` extension: outputs an ER diagram PNG image
+
 ```dbml
 Table user {
   id varchar [pk, note: 'Primary key']
@@ -256,67 +336,60 @@ Table post {
 Ref post_userId_user_id_fk: post.userId > user.id
 ```
 
-### PNG/SVG
-
-The `svg` generator outputs ER diagrams as PNG or SVG images using [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer).
-
-Output: `docs/er-diagram.png`
-
 ## Configuration
 
-### Zod Options
-
-| Option     | Type      | Default        | Description                                                      |
-|------------|-----------|----------------|------------------------------------------------------------------|
-| `output`   | `string`  | `zod/index.ts` | Output file path                                                 |
-| `type`     | `boolean` | `false`        | Generate TypeScript types                                        |
-| `comment`  | `boolean` | `false`        | Include schema documentation                                     |
-| `zod`      | `string`  | `'v4'`         | Zod import version (`'mini'`, `'@hono/zod-openapi'`, or `'v4'`)  |
-| `relation` | `boolean` | `false`        | Generate relation schemas                                        |
-
-### Valibot Options
-
-| Option     | Type      | Default            | Description                  |
-|------------|-----------|--------------------|------------------------------|
-| `output`   | `string`  | `valibot/index.ts` | Output file path             |
-| `type`     | `boolean` | `false`            | Generate TypeScript types    |
-| `comment`  | `boolean` | `false`            | Include schema documentation |
-| `relation` | `boolean` | `false`            | Generate relation schemas    |
-
-### ArkType Options
-
-| Option    | Type      | Default            | Description                  |
-|-----------|-----------|--------------------|------------------------------|
-| `output`  | `string`  | `arktype/index.ts` | Output file path             |
-| `type`    | `boolean` | `false`            | Generate TypeScript types    |
-| `comment` | `boolean` | `false`            | Include schema documentation |
-
-### Effect Options
+```typescript
+import { defineConfig } from 'sizuku/config'
 
-| Option    | Type      | Default           | Description                  |
-|-----------|-----------|-------------------|------------------------------|
-| `output`  | `string`  | `effect/index.ts` | Output file path             |
-| `type`    | `boolean` | `false`           | Generate TypeScript types    |
-| `comment` | `boolean` | `false`           | Include schema documentation |
+export default defineConfig({
+  // Input: Path to Drizzle schema file (must end with .ts)
+  input: 'db/schema.ts',
 
-### Mermaid Options
+  // Zod Schema Generator
+  zod: {
+    output: 'zod/index.ts',       // Output file path (must end with .ts)
+    comment: true,                 // Include schema documentation (default: false)
+    type: true,                    // Generate TypeScript types (default: false)
+    zod: 'v4',                     // Zod import: 'v4' | 'mini' | '@hono/zod-openapi' (default: 'v4')
+    relation: true,                // Generate relation schemas (default: false)
+  },
 
-| Option   | Type     | Default          | Description      |
-|----------|----------|------------------|------------------|
-| `output` | `string` | `mermaid-er/ER.md` | Output file path |
+  // Valibot Schema Generator
+  valibot: {
+    output: 'valibot/index.ts',
+    comment: true,
+    type: true,
+    relation: true,
+  },
 
-### DBML Options
+  // ArkType Schema Generator
+  arktype: {
+    output: 'arktype/index.ts',
+    comment: true,
+    type: true,
+    relation: true,                // Generate relation schemas (default: false)
+  },
 
-| Option   | Type     | Default            | Description      |
-|----------|----------|--------------------|------------------|
-| `output` | `string` | `dbml/schema.dbml` | Output file path |
+  // Effect Schema Generator
+  effect: {
+    output: 'effect/index.ts',
+    comment: true,
+    type: true,
+    relation: true,                // Generate relation schemas (default: false)
+  },
 
-### SVG Options
+  // Mermaid ER Diagram Generator
+  mermaid: {
+    output: 'mermaid-er/ER.md',    // Output file path
+  },
 
-| Option   | Type     | Default               | Description                              |
-|----------|----------|-----------------------|------------------------------------------|
-| `output` | `string` | `docs/er-diagram.png` | Output file path                         |
-| `format` | `string` | `png`                 | Output format (`png`, `svg`, or `dot`)   |
+  // DBML / ER Diagram PNG Generator
+  // Use .dbml extension for DBML text, .png extension for ER diagram image
+  dbml: {
+    output: 'docs/schema.dbml',    // Output file path (must end with .dbml or .png)
+  },
+})
+```
 
 ### ⚠️ WARNING: Potential Breaking Changes Without Notice
 
@@ -324,4 +397,4 @@ This package is in active development and may introduce breaking changes without
 
 ## License
 
-Distributed under the MIT License. See [LICENSE](https://github.com/nakita628/hono-takibi?tab=MIT-1-ov-file) for more information.
+Distributed under the MIT License. See [LICENSE](https://github.com/nakita628/sizuku?tab=MIT-1-ov-file) for more information.

package/dist/config/index.d.mts

@@ -24,11 +24,13 @@ declare const configSchema: z.ZodObject<{
     output: z.ZodType<`${string}.ts`, unknown, z.core.$ZodTypeInternals<`${string}.ts`, unknown>>;
     comment: z.ZodOptional<z.ZodBoolean>;
     type: z.ZodOptional<z.ZodBoolean>;
+    relation: z.ZodOptional<z.ZodBoolean>;
   }, z.core.$strip>>;
   effect: z.ZodOptional<z.ZodObject<{
     output: z.ZodType<`${string}.ts`, unknown, z.core.$ZodTypeInternals<`${string}.ts`, unknown>>;
     comment: z.ZodOptional<z.ZodBoolean>;
     type: z.ZodOptional<z.ZodBoolean>;
+    relation: z.ZodOptional<z.ZodBoolean>;
   }, z.core.$strip>>;
   mermaid: z.ZodOptional<z.ZodObject<{
     output: z.ZodString;
@@ -38,7 +40,7 @@ declare const configSchema: z.ZodObject<{
   }, z.core.$strip>>;
 }, z.core.$strip>;
 type Config = z.infer<typeof configSchema>;
-declare function config(): Promise<{
+declare function readConfig(): Promise<{
   readonly ok: true;
   readonly value: Config;
 } | {
@@ -47,4 +49,4 @@ declare function config(): Promise<{
 }>;
 declare function defineConfig(config: Config): Config;
 //#endregion
-export { Config, config, defineConfig };
+export { Config, defineConfig, readConfig };

package/dist/config/index.mjs

@@ -6,7 +6,6 @@ import { z } from "zod";
 
 //#region src/config/index.ts
 const tsFileSchema = z.string().endsWith(".ts");
-const directorySchema = z.string();
 const zodConfigSchema = z.object({
 	output: tsFileSchema,
 	comment: z.boolean().optional(),
@@ -27,15 +26,17 @@ const valibotConfigSchema = z.object({
 const arktypeConfigSchema = z.object({
 	output: tsFileSchema,
 	comment: z.boolean().optional(),
-	type: z.boolean().optional()
+	type: z.boolean().optional(),
+	relation: z.boolean().optional()
 }).optional();
 const effectConfigSchema = z.object({
 	output: tsFileSchema,
 	comment: z.boolean().optional(),
-	type: z.boolean().optional()
+	type: z.boolean().optional(),
+	relation: z.boolean().optional()
 }).optional();
 const mermaidConfigSchema = z.object({ output: z.string() }).optional();
-const dbmlConfigSchema = z.object({ output: directorySchema }).optional();
+const dbmlConfigSchema = z.object({ output: z.string().refine((s) => s.endsWith(".dbml") || s.endsWith(".png"), { message: "output must end with .dbml or .png" }) }).optional();
 const configSchema = z.object({
 	input: tsFileSchema,
 	zod: zodConfigSchema,
@@ -45,7 +46,7 @@ const configSchema = z.object({
 	mermaid: mermaidConfigSchema,
 	dbml: dbmlConfigSchema
 });
-async function config() {
+async function readConfig() {
 	const abs = resolve(process.cwd(), "sizuku.config.ts");
 	if (!existsSync(abs)) return {
 		ok: false,
@@ -83,4 +84,4 @@ function defineConfig(config) {
 }
 
 //#endregion
-export { config, defineConfig };
+export { defineConfig, readConfig };

package/dist/index.d.mts

@@ -1,10 +1 @@
-//#region src/index.d.ts
-declare function main(): Promise<{
-  readonly ok: true;
-  readonly value: string;
-} | {
-  readonly ok: false;
-  readonly error: string;
-}>;
-//#endregion
-export { main };
+export { };