sizuku 0.1.0 → 0.2.0

package/dist/src/shared/helper/is-relation-function.js

@@ -0,0 +1,16 @@
+import { Node } from 'ts-morph';
+/**
+ * Determines whether a given `CallExpression` is a relation-related function call.
+ *
+ * This checks if the function name is either `"relations"` or contains the substring `"relation"`.
+ *
+ * @param callExpr - The call expression node to check.
+ * @returns `true` if the function is a relation function; otherwise, `false`.
+ */
+export function isRelationFunctionCall(callExpr) {
+    const expression = callExpr.getExpression();
+    if (!Node.isIdentifier(expression))
+        return false;
+    const functionName = expression.getText();
+    return functionName === 'relations' || functionName.includes('relation');
+}

package/dist/src/shared/utils/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Capitalize the first letter of a string.
+ *
+ * @param str - The input string.
+ * @returns A new string with the first letter capitalized.
+ */
+export declare function capitalize(str: string): string;
+/**
+ * Generate schema name from table name.
+ *
+ * @param str - The table name.
+ * @returns A schema name with PascalCase and Schema suffix.
+ */
+export declare function schemaName(str: string): string;
+/**
+ * Parse field comments and extract definition line and description.
+ *
+ * @param commentLines - Raw comment lines (e.g., from source text)
+ * @param tag - The tag to look for (e.g., '@v.' or '@z.')
+ * @returns Parsed definition and description
+ */
+export declare function parseFieldComments(commentLines: string[], tag: '@v.' | '@z.'): {
+    definition: string;
+    description?: string;
+};
+/**
+ * Extract field comments from source text.
+ *
+ * @param sourceText - The source text to extract comments from.
+ * @param fieldStartPos - The start position of the field.
+ * @returns Array of comment lines.
+ */
+export declare function extractFieldComments(sourceText: string, fieldStartPos: number): string[];

package/dist/src/shared/utils/index.js

@@ -0,0 +1,61 @@
+/**
+ * Capitalize the first letter of a string.
+ *
+ * @param str - The input string.
+ * @returns A new string with the first letter capitalized.
+ */
+export function capitalize(str) {
+    return `${str.charAt(0).toUpperCase()}${str.slice(1)}`;
+}
+/**
+ * Generate schema name from table name.
+ *
+ * @param str - The table name.
+ * @returns A schema name with PascalCase and Schema suffix.
+ */
+export function schemaName(str) {
+    return `${capitalize(str)}Schema`;
+}
+/**
+ * Parse field comments and extract definition line and description.
+ *
+ * @param commentLines - Raw comment lines (e.g., from source text)
+ * @param tag - The tag to look for (e.g., '@v.' or '@z.')
+ * @returns Parsed definition and description
+ */
+export function parseFieldComments(commentLines, tag) {
+    const cleaned = commentLines.map((line) => line.replace(/^\/\/\/\s*/, '').trim()).filter(Boolean);
+    const definition = cleaned.find((line) => line.startsWith(tag))?.replace(/^@/, '') ?? '';
+    const descriptionLines = cleaned.filter((line) => !(line.includes('@z.') || line.includes('@v.') || line.includes('@relation.')));
+    const description = descriptionLines.length ? descriptionLines.join(' ') : undefined;
+    return { definition, description };
+}
+/**
+ * Extract field comments from source text.
+ *
+ * @param sourceText - The source text to extract comments from.
+ * @param fieldStartPos - The start position of the field.
+ * @returns Array of comment lines.
+ */
+export function extractFieldComments(sourceText, fieldStartPos) {
+    const beforeField = sourceText.substring(0, fieldStartPos);
+    const lines = beforeField.split('\n');
+    const reverseIndex = lines
+        .map((line, index) => ({ line: line.trim(), index }))
+        .reverse()
+        .reduce((acc, { line }) => {
+        if (acc.shouldStop)
+            return acc;
+        if (line.startsWith('///')) {
+            return {
+                commentLines: [line, ...acc.commentLines],
+                shouldStop: false,
+            };
+        }
+        if (line === '') {
+            return acc;
+        }
+        return { commentLines: acc.commentLines, shouldStop: true };
+    }, { commentLines: [], shouldStop: false });
+    return reverseIndex.commentLines;
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Capitalize the first letter of a string.
+ *
+ * @param str - The input string.
+ * @returns A new string with the first letter capitalized.
+ */
+export declare function capitalize(str: string): string;
+/**
+ * Remove triple slash prefix from a string.
+ *
+ * @param str - The input string.
+ * @returns String with triple slash prefix removed.
+ */
+export declare function removeTripleSlash(str: string): string;
+/**
+ * Check if a string is non-empty.
+ *
+ * @param str - The input string.
+ * @returns True if string is non-empty.
+ */
+export declare function isNonEmpty(str: string): boolean;
+/**
+ * Check if a string contains a substring.
+ *
+ * @param str - The input string.
+ * @param substr - The substring to search for.
+ * @returns True if string contains substring.
+ */
+export declare function containsSubstring(str: string, substr: string): boolean;
+/**
+ * Check if a string starts with a prefix.
+ *
+ * @param str - The input string.
+ * @param prefix - The prefix to check.
+ * @returns True if string starts with prefix.
+ */
+export declare function startsWith(str: string, prefix: string): boolean;
+/**
+ * Remove @ sign from the beginning of a string.
+ *
+ * @param str - The input string.
+ * @returns String with @ sign removed.
+ */
+export declare function removeAtSign(str: string): string;
+/**
+ * Join array of strings with space separator.
+ *
+ * @param arr - Array of strings to join.
+ * @returns Joined string with spaces.
+ */
+export declare function joinWithSpace(arr: string[]): string;
+/**
+ * Split string by newline character.
+ *
+ * @param str - The input string.
+ * @returns Array of strings split by newline.
+ */
+export declare function splitByNewline(str: string): string[];
+/**
+ * Trim whitespace from string.
+ *
+ * @param str - The input string.
+ * @returns Trimmed string.
+ */
+export declare function trimString(str: string): string;
+/**
+ * Parse relation line and extract components.
+ *
+ * @param line - The line to parse.
+ * @returns Parsed relation or null if not a relation line.
+ */
+export declare function parseRelationLine(line: string): {
+    fromModel: string;
+    toModel: string;
+    fromField: string;
+    toField: string;
+    type: string;
+} | null;
+/**
+ * Split string by '-to-' delimiter.
+ *
+ * @param str - The input string.
+ * @returns Array with two parts or null if not found.
+ */
+export declare function splitByTo(str: string): [string, string] | null;
+/**
+ * Remove optional suffix from string.
+ *
+ * @param str - The input string.
+ * @returns String with optional suffix removed.
+ */
+export declare function removeOptionalSuffix(str: string): string;
+/**
+ * Split string by whitespace.
+ *
+ * @param str - The input string.
+ * @returns Array of strings split by whitespace.
+ */
+export declare function splitByWhitespace(str: string): string[];
+/**
+ * Split string by dot character.
+ *
+ * @param str - The input string.
+ * @returns Array of strings split by dot.
+ */
+export declare function splitByDot(str: string): string[];
+/**
+ * Parse field comments and extract definition line and description.
+ *
+ * @param commentLines - Raw comment lines (e.g., from source text)
+ * @param tag - The tag to look for (e.g., '@v.' or '@z.')
+ * @returns Parsed definition and description
+ */
+export declare function parseFieldComments(commentLines: string[], tag: '@v.' | '@z.'): {
+    definition: string;
+    description?: string;
+    objectType?: 'strict' | 'loose';
+};
+/**
+ * Extract field comments from source text.
+ *
+ * @param sourceText - The source text to extract comments from.
+ * @param fieldStartPos - The position of the field in the source text.
+ * @returns An array of comment lines.
+ */
+export declare function extractFieldComments(sourceText: string, fieldStartPos: number): string[];
+/**
+ * @param name
+ * @returns
+ */
+export declare function infer(name: string): string;
+export declare function inferInput(name: string): string;
+/**
+ * @param schema
+ * @returns
+ */
+export declare function fieldDefinitions(schema: {
+    name: string;
+    fields: {
+        name: string;
+        definition: string;
+        description?: string;
+    }[];
+}, comment: boolean): string;

package/dist/utils/index.js

@@ -0,0 +1,301 @@
+/* ========================================================================== *
+ *  text
+ * ========================================================================== */
+/**
+ * Capitalize the first letter of a string.
+ *
+ * @param str - The input string.
+ * @returns A new string with the first letter capitalized.
+ */
+export function capitalize(str) {
+    return `${str.charAt(0).toUpperCase()}${str.slice(1)}`;
+}
+/**
+ * Remove triple slash prefix from a string.
+ *
+ * @param str - The input string.
+ * @returns String with triple slash prefix removed.
+ */
+export function removeTripleSlash(str) {
+    return str.startsWith('///') ? str.substring(3) : str;
+}
+/**
+ * Check if a string is non-empty.
+ *
+ * @param str - The input string.
+ * @returns True if string is non-empty.
+ */
+export function isNonEmpty(str) {
+    return str.length > 0;
+}
+/**
+ * Check if a string contains a substring.
+ *
+ * @param str - The input string.
+ * @param substr - The substring to search for.
+ * @returns True if string contains substring.
+ */
+export function containsSubstring(str, substr) {
+    return str.indexOf(substr) !== -1;
+}
+/**
+ * Check if a string starts with a prefix.
+ *
+ * @param str - The input string.
+ * @param prefix - The prefix to check.
+ * @returns True if string starts with prefix.
+ */
+export function startsWith(str, prefix) {
+    return str.indexOf(prefix) === 0;
+}
+/**
+ * Remove @ sign from the beginning of a string.
+ *
+ * @param str - The input string.
+ * @returns String with @ sign removed.
+ */
+export function removeAtSign(str) {
+    return str.startsWith('@') ? str.substring(1) : str;
+}
+/**
+ * Join array of strings with space separator.
+ *
+ * @param arr - Array of strings to join.
+ * @returns Joined string with spaces.
+ */
+export function joinWithSpace(arr) {
+    return arr.join(' ');
+}
+/**
+ * Split string by newline character.
+ *
+ * @param str - The input string.
+ * @returns Array of strings split by newline.
+ */
+export function splitByNewline(str) {
+    const result = [];
+    let current = '';
+    for (let i = 0; i < str.length; i++) {
+        if (str[i] === '\n') {
+            result.push(current);
+            current = '';
+        }
+        else {
+            current += str[i];
+        }
+    }
+    result.push(current);
+    return result;
+}
+/**
+ * Trim whitespace from string.
+ *
+ * @param str - The input string.
+ * @returns Trimmed string.
+ */
+export function trimString(str) {
+    let start = 0;
+    let end = str.length - 1;
+    while (start <= end &&
+        (str[start] === ' ' || str[start] === '\t' || str[start] === '\r' || str[start] === '\n')) {
+        start++;
+    }
+    while (end >= start &&
+        (str[end] === ' ' || str[end] === '\t' || str[end] === '\r' || str[end] === '\n')) {
+        end--;
+    }
+    return str.substring(start, end + 1);
+}
+/**
+ * Parse relation line and extract components.
+ *
+ * @param line - The line to parse.
+ * @returns Parsed relation or null if not a relation line.
+ */
+export function parseRelationLine(line) {
+    if (!startsWith(line, '@relation'))
+        return null;
+    const parts = splitByWhitespace(line);
+    if (parts.length < 5)
+        return null;
+    const fromParts = splitByDot(parts[1]);
+    const toParts = splitByDot(parts[2]);
+    if (fromParts.length !== 2 || toParts.length !== 2)
+        return null;
+    return {
+        fromModel: fromParts[0],
+        fromField: fromParts[1],
+        toModel: toParts[0],
+        toField: toParts[1],
+        type: parts[3],
+    };
+}
+/**
+ * Split string by '-to-' delimiter.
+ *
+ * @param str - The input string.
+ * @returns Array with two parts or null if not found.
+ */
+export function splitByTo(str) {
+    const index = str.indexOf('-to-');
+    if (index === -1)
+        return null;
+    return [str.substring(0, index), str.substring(index + 4)];
+}
+/**
+ * Remove optional suffix from string.
+ *
+ * @param str - The input string.
+ * @returns String with optional suffix removed.
+ */
+export function removeOptionalSuffix(str) {
+    const index = str.indexOf('-optional');
+    return index !== -1 ? str.substring(0, index) : str;
+}
+/**
+ * Split string by whitespace.
+ *
+ * @param str - The input string.
+ * @returns Array of strings split by whitespace.
+ */
+export function splitByWhitespace(str) {
+    const result = [];
+    let current = '';
+    let inWord = false;
+    for (let i = 0; i < str.length; i++) {
+        const char = str[i];
+        const isWhitespace = char === ' ' || char === '\t' || char === '\r' || char === '\n';
+        if (isWhitespace) {
+            if (inWord) {
+                result.push(current);
+                current = '';
+                inWord = false;
+            }
+        }
+        else {
+            current += char;
+            inWord = true;
+        }
+    }
+    if (inWord) {
+        result.push(current);
+    }
+    return result;
+}
+/**
+ * Split string by dot character.
+ *
+ * @param str - The input string.
+ * @returns Array of strings split by dot.
+ */
+export function splitByDot(str) {
+    const result = [];
+    let current = '';
+    for (let i = 0; i < str.length; i++) {
+        if (str[i] === '.') {
+            result.push(current);
+            current = '';
+        }
+        else {
+            current += str[i];
+        }
+    }
+    result.push(current);
+    return result;
+}
+/* ========================================================================== *
+ *  parse
+ * ========================================================================== */
+/**
+ * Parse field comments and extract definition line and description.
+ *
+ * @param commentLines - Raw comment lines (e.g., from source text)
+ * @param tag - The tag to look for (e.g., '@v.' or '@z.')
+ * @returns Parsed definition and description
+ */
+export function parseFieldComments(commentLines, tag) {
+    const cleaned = commentLines.map((line) => removeTripleSlash(line).trim()).filter(isNonEmpty);
+    // Extract object type from strictObject/looseObject tags
+    const objectTypeLine = cleaned.find((line) => containsSubstring(line, `${tag.slice(1)}strictObject`) ||
+        containsSubstring(line, `${tag.slice(1)}looseObject`));
+    const objectType = objectTypeLine && containsSubstring(objectTypeLine, 'strictObject')
+        ? 'strict'
+        : objectTypeLine && containsSubstring(objectTypeLine, 'looseObject')
+            ? 'loose'
+            : undefined;
+    // Extract definition (excluding strictObject/looseObject tags)
+    const definitionLine = cleaned.find((line) => startsWith(line, tag) &&
+        !containsSubstring(line, 'strictObject') &&
+        !containsSubstring(line, 'looseObject'));
+    const definition = definitionLine ? removeAtSign(definitionLine) : '';
+    const descriptionLines = cleaned.filter((line) => !(containsSubstring(line, '@z.') ||
+        containsSubstring(line, '@v.') ||
+        containsSubstring(line, '@relation.')));
+    const description = descriptionLines.length > 0 ? joinWithSpace(descriptionLines) : undefined;
+    return { definition, description, objectType };
+}
+/* ========================================================================== *
+ *  extractFieldComments
+ * ========================================================================== */
+/**
+ * Extract field comments from source text.
+ *
+ * @param sourceText - The source text to extract comments from.
+ * @param fieldStartPos - The position of the field in the source text.
+ * @returns An array of comment lines.
+ */
+export function extractFieldComments(sourceText, fieldStartPos) {
+    const beforeField = sourceText.substring(0, fieldStartPos);
+    const lines = splitByNewline(beforeField);
+    const reverseIndex = lines
+        .map((line, index) => ({ line: trimString(line), index }))
+        .reverse()
+        .reduce((acc, { line }) => {
+        if (acc.shouldStop)
+            return acc;
+        if (startsWith(line, '///')) {
+            return {
+                commentLines: [line, ...acc.commentLines],
+                shouldStop: false,
+            };
+        }
+        if (line === '') {
+            return acc;
+        }
+        return { commentLines: acc.commentLines, shouldStop: true };
+    }, { commentLines: [], shouldStop: false });
+    return reverseIndex.commentLines;
+}
+/* ========================================================================== *
+ *  zod
+ * ========================================================================== */
+/**
+ * @param name
+ * @returns
+ */
+export function infer(name) {
+    const capitalizedName = name.charAt(0).toUpperCase() + name.slice(1);
+    return `export type ${capitalizedName} = z.infer<typeof ${capitalizedName}Schema>`;
+}
+/* ========================================================================== *
+ *  valibot
+ * ========================================================================== */
+export function inferInput(name) {
+    const capitalizedName = name.charAt(0).toUpperCase() + name.slice(1);
+    return `export type ${capitalizedName} = v.InferInput<typeof ${capitalizedName}Schema>`;
+}
+/* ========================================================================== *
+ *  schema
+ * ========================================================================== */
+/**
+ * @param schema
+ * @returns
+ */
+export function fieldDefinitions(schema, comment) {
+    return schema.fields
+        .map(({ name, definition, description }) => {
+        const commentCode = description && comment ? `/**\n* ${description}\n*/\n` : '';
+        return `${commentCode}${name}:${definition}`;
+    })
+        .join(',\n');
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sizuku",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Sizuku is a tool that generates validation schemas for Zod and Valibot, as well as ER diagrams, from Drizzle schemas annotated with comments.",
   "license": "MIT",
   "keywords": [
@@ -31,9 +31,6 @@
   },
   "scripts": {
     "deps": "rm -rf node_modules && pnpm install",
-    "demo-er": "sizuku-mermaid-er db/schema.ts -o mermaid-er/ER.md",
-    "demo-z": "sizuku-zod db/schema.ts -o zod/index.ts",
-    "demo-v": "sizuku-valibot db/schema.ts -o valibot/index.ts",
     "build": "tsc",
     "typecheck": "tsc --noEmit",
     "dev": "pnpm --filter sizuku-test dev",
@@ -47,10 +44,9 @@
     "drizzle-orm": "^0.40.1",
     "valibot": "1.0.0-rc.3",
     "vitest": "^3.2.4",
-    "zod": "^3.25.67"
+    "zod": "^4.0.15"
   },
   "dependencies": {
-    "neverthrow": "^8.2.0",
     "prettier": "^3.6.2",
     "ts-morph": "^26.0.0"
   }