@chihqiang/sql-quicktype 0.0.2 → 0.0.4

package/dist/index.mjs

@@ -33,8 +33,8 @@ SQL length: ${sql.length} characters`
 var SQLParser = class {
   constructor(options = { dialect: "mysql" }) {
     /**
-     * 默认类型解析器
-     * 提供基本的 SQL 类型到 SQLType 的映射逻辑
+     * Default type resolver
+     * Provides basic SQL type to SQLType mapping logic
      */
     this.defaultTypeResolver = {
       resolve: (def) => {
@@ -134,8 +134,8 @@ var SQLParser = class {
             };
             return emptyEnumType;
           /**
-           * 未识别类型默认降级为 text，避免解析失败
-           * 在严格模式下，遇到未识别的类型会抛出错误
+           * Unrecognized types fall back to text by default to avoid parse failure
+           * In strict mode, unrecognized types throw an error
            */
           default:
             if (this.options.strictMode) {
@@ -157,7 +157,7 @@ var SQLParser = class {
     this.parser = new Parser();
   }
   /**
-   * 遍历 AST，提取所有 CREATE TABLE
+   * Traverse AST, extract all CREATE TABLE statements
    */
   parseDatabase(ast, dbName = this.options.dbName || "db") {
     const db = {
@@ -176,7 +176,7 @@ var SQLParser = class {
     return db;
   }
   /**
-   * 类型守卫：判断是否为 CREATE TABLE 语句
+   * Type guard: check if node is a CREATE TABLE statement
    */
   isCreateTable(node) {
     if (!node || typeof node !== "object") return false;
@@ -184,7 +184,7 @@ var SQLParser = class {
     return n.type === "create" && n.keyword === "table";
   }
   /**
-   * 解析单表 AST -> TableSchema
+   * Parse single table AST -> TableSchema
    */
   parseTable(node) {
     var _a, _b, _c, _d;
@@ -228,9 +228,9 @@ var SQLParser = class {
     return table;
   }
   /**
-   * 解析列定义 AST -> ColumnSchema
+   * Parse column definition AST -> ColumnSchema
    *
-   * 注意：字段级 primary/unique 与表级定义会叠加
+   * Note: Field-level primary/unique and table-level definitions will overlap
    */
   parseColumn(def) {
     var _a, _b, _c;
@@ -244,18 +244,18 @@ var SQLParser = class {
     return {
       name: columnName,
       /**
-       * 抽象 SQL 类型映射
+       * Abstract SQL type mapping
        */
       type: this.mapSQLType(def.definition),
       /**
-       * node-sql-parser 中：
-       * nullable 是一个对象，当它存在且 type 是 "not null" 时，表示 NOT NULL
+       * In node-sql-parser:
+       * nullable is an object; when it exists and type is "not null", it means NOT NULL
        */
       nullable: !(def.nullable && def.nullable.type === "not null"),
       primaryKey: !!def.primary_key,
       unique: !!def.unique,
       /**
-       * 默认值需要序列化为 SQL 字符串
+       * Default value needs to be serialized as SQL string
        */
       default: def.default_val ? this.parseDefault(def.default_val) : void 0,
       comment: (_c = (_b = def.comment) == null ? void 0 : _b.value) == null ? void 0 : _c.value,
@@ -264,7 +264,7 @@ var SQLParser = class {
     };
   }
   /**
-   * 解析表级 PRIMARY KEY / UNIQUE / FOREIGN KEY
+   * Parse table-level PRIMARY KEY / UNIQUE / FOREIGN KEY
    */
   parseTableConstraint(def, table) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
@@ -316,7 +316,7 @@ var SQLParser = class {
     }
   }
   /**
-   * 解析普通索引
+   * Parse regular index
    */
   parseIndex(def, table) {
     var _a;
@@ -330,7 +330,7 @@ var SQLParser = class {
     }
   }
   /**
-   * SQL AST 类型 -> SQLType（跨方言抽象）
+   * SQL AST type -> SQLType (cross-dialect abstraction)
    */
   mapSQLType(def) {
     const allResolvers = [
@@ -347,9 +347,9 @@ var SQLParser = class {
     return textType;
   }
   /**
-   * 默认值 AST -> SQL 字符串
+   * Default value AST -> SQL string
    *
-   * 使用 sqlify 确保函数/表达式被正确序列化
+   * Uses sqlify to ensure functions/expressions are serialized correctly
    */
   parseDefault(def) {
     var _a, _b;
@@ -379,13 +379,13 @@ var BaseGenerator = class {
     this.needsTimeCache = null;
   }
   /**
-   * 格式化类型名称（如驼峰命名、帕斯卡命名等）
+   * Format type name (e.g., PascalCase)
    */
   formatTypeName(name) {
     return name.split("_").map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase()).join("");
   }
   /**
-   * 格式化字段名称
+   * Format field name
    */
   formatPascalCase(name) {
     return name.split("_").map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase()).join("");
@@ -394,7 +394,7 @@ var BaseGenerator = class {
     return this.formatPascalCase(name);
   }
   /**
-   * 生成默认值
+   * Generate default value
    */
   generateDefaultValue(column) {
     if (!column.default) {
@@ -437,7 +437,7 @@ var TypeScriptGenerator = class extends BaseGenerator {
     this.options = options;
   }
   /**
-   * 格式化字段名称（使用驼峰命名）
+   * Format field name (camelCase)
    */
   formatFieldName(name) {
     return name.split("_").map((part, index) => {
@@ -448,7 +448,7 @@ var TypeScriptGenerator = class extends BaseGenerator {
     }).join("");
   }
   /**
-   * 生成整个数据库模式的类型定义
+   * Generate type definitions for the entire database schema
    */
   generateDatabase(database) {
     let result = `// Database: ${database.name}
@@ -463,10 +463,10 @@ var TypeScriptGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成单个表的类型定义
+   * Generate type definition for a single table
    */
   generateTable(table) {
-    let result = `// ${table.name} \u8868\u7ED3\u6784
+    let result = `// ${table.name} table structure
 `;
     result += `export interface ${this.formatTypeName(table.name)} {
 `;
@@ -477,7 +477,7 @@ var TypeScriptGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成列的类型定义
+   * Generate column type definition
    */
   generateColumn(column) {
     const fieldName = this.formatFieldName(column.name);
@@ -491,7 +491,7 @@ var TypeScriptGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 映射 SQL 类型到 TypeScript 类型
+   * Map SQL type to TypeScript type
    */
   mapSQLType(type, columnName) {
     switch (type.kind) {
@@ -534,7 +534,7 @@ var GoGenerator = class extends BaseGenerator {
     this.options = options;
   }
   /**
-   * 生成整个数据库模式的类型定义
+   * Generate type definitions for the entire database schema
    */
   generateDatabase(database) {
     let result = `// Database: ${database.name}
@@ -559,10 +559,10 @@ var GoGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成单个表的类型定义
+   * Generate type definition for a single table
    */
   generateTable(table) {
-    let result = `// ${table.name} \u8868\u7ED3\u6784
+    let result = `// ${table.name} table structure
 `;
     result += `type ${this.formatTypeName(table.name)} struct {
 `;
@@ -573,7 +573,7 @@ var GoGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成列的类型定义
+   * Generate column type definition
    */
   generateColumn(column) {
     const fieldName = this.formatFieldName(column.name);
@@ -587,7 +587,7 @@ var GoGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 映射 SQL 类型到 Go 类型
+   * Map SQL type to Go type
    */
   mapSQLType(type) {
     switch (type.kind) {
@@ -616,7 +616,7 @@ var GoGenerator = class extends BaseGenerator {
     }
   }
   /**
-   * 生成 Go 结构体标签
+   * Generate Go struct tags
    */
   generateGoTag(column) {
     const tags = [];
@@ -633,7 +633,7 @@ var GormGenerator = class extends BaseGenerator {
     this.options = options;
   }
   /**
-   * 生成整个数据库模式的类型定义
+   * Generate type definitions for the entire database schema
    */
   generateDatabase(database) {
     let result = `// Database: ${database.name}
@@ -658,10 +658,10 @@ var GormGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成单个表的类型定义
+   * Generate type definition for a single table
    */
   generateTable(table) {
-    let result = `// ${table.name} \u8868\u7ED3\u6784
+    let result = `// ${table.name} table structure
 `;
     result += `type ${this.formatTypeName(table.name)} struct {
 `;
@@ -672,7 +672,7 @@ var GormGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成列的类型定义
+   * Generate column type definition
    */
   generateColumn(column) {
     const fieldName = this.formatFieldName(column.name);
@@ -686,7 +686,7 @@ var GormGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 映射 SQL 类型到 GORM 类型
+   * Map SQL type to GORM type
    */
   mapSQLType(type) {
     switch (type.kind) {
@@ -715,7 +715,7 @@ var GormGenerator = class extends BaseGenerator {
     }
   }
   /**
-   * 生成 GORM 结构体标签
+   * Generate GORM struct tags
    */
   generateGormTag(column) {
     const tags = [];
@@ -811,7 +811,7 @@ var XormGenerator = class extends BaseGenerator {
     this.options = options;
   }
   /**
-   * 生成整个数据库模式的类型定义
+   * Generate type definitions for the entire database schema
    */
   generateDatabase(database) {
     let result = `// Database: ${database.name}
@@ -836,10 +836,10 @@ var XormGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成单个表的类型定义
+   * Generate type definition for a single table
    */
   generateTable(table) {
-    let result = `// ${table.name} \u8868\u7ED3\u6784
+    let result = `// ${table.name} table structure
 `;
     result += `type ${this.formatTypeName(table.name)} struct {
 `;
@@ -850,7 +850,7 @@ var XormGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 生成列的类型定义
+   * Generate column type definition
    */
   generateColumn(column) {
     const fieldName = this.formatFieldName(column.name);
@@ -864,7 +864,7 @@ var XormGenerator = class extends BaseGenerator {
     return result;
   }
   /**
-   * 映射 SQL 类型到 XORM 类型
+   * Map SQL type to XORM type
    */
   mapSQLType(type) {
     switch (type.kind) {
@@ -893,7 +893,7 @@ var XormGenerator = class extends BaseGenerator {
     }
   }
   /**
-   * 生成 XORM 结构体标签
+   * Generate XORM struct tags
    */
   generateXormTag(column) {
     const tags = [];
@@ -1007,28 +1007,6 @@ function generateCode(sql, options) {
   );
   return generator.generateDatabase(dbSchema);
 }
-
-// src/reader/index.ts
-import * as fs from "fs/promises";
-async function readSQLFromFile(path) {
-  if (!path) {
-    throw new Error("File path is required");
-  }
-  try {
-    return await fs.readFile(path, "utf-8");
-  } catch (error) {
-    if ((error == null ? void 0 : error.code) === "ENOENT") {
-      throw new Error(`File not found: ${path}`);
-    }
-    throw error;
-  }
-}
-async function readSQLFromString(sql) {
-  if (!sql) {
-    throw new Error("SQL string is required");
-  }
-  return sql;
-}
 export {
   BaseGenerator,
   GeneratorFactory,
@@ -1038,7 +1016,5 @@ export {
   TypeScriptGenerator,
   XormGenerator,
   generateCode,
-  parseSQL,
-  readSQLFromFile,
-  readSQLFromString
+  parseSQL
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chihqiang/sql-quicktype",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A tool to generate TypeScript, Go, GORM, and XORM types from SQL DDL statements",
   "keywords": [
     "sql",