@zenorm/generate 1.1.1 → 1.3.0

package/CHANGELOG.md

@@ -1,15 +1,21 @@
-# Changelog
-
-## [1.1.1] - 2023-3-24
-- fix: 生成格式少个空格和空行
-- update: bindQuery 增加 count 和 exists
-- 补充注释说明
-
-## [1.1.0] - 2023-3-24
-- 新增: 绑定静态 Query
-
-## [1.0.0] - 2023-3-23
-- 完善
-
-## [0.0.1] - 2023-3-23
-- 从 zenorm@3.25.0 分离为独立项目
+# Changelog
+
+## [1.3.0] - 2023-3-25
+- update: bindQuery 增加 save, update, delete
+
+## [1.2.0] - 2023-3-24
+- update: bindQuery 改为函数形式
+
+## [1.1.1] - 2023-3-24
+- fix: 生成格式少个空格和空行
+- update: bindQuery 增加 count 和 exists
+- 补充注释说明
+
+## [1.1.0] - 2023-3-24
+- 新增: 绑定静态 Query
+
+## [1.0.0] - 2023-3-23
+- 完善
+
+## [0.0.1] - 2023-3-23
+- 从 zenorm@3.25.0 分离为独立项目

package/README.md

@@ -1,24 +1,24 @@
-# ZenORM Generate
-
-[ZenORM](https://www.npmjs.com/package/zenorm) Table Structure Code Generation Tool
-
-表结构代码生成工具
-
-## Generate Config - 代码生成配置
-
-| 配置项 | 类型 | 默认值 | 说明
-| ----- | --- | ----- | ----
-| host | `string` | 无 | 目标数据库地址
-| port | `number` | 无 | 数据库端口
-| user | `string` | 无 | 数据库用户名
-| password | `string` | 无 | 数据库密码
-| database | `string` | 无 | 数据库名
-| outputDir | `string` | `'./src/model'` | 代码输出目录
-| tablesFilename | `string` | `'_tables'` | 生成数据库表结构文件名
-| repositoriesFilename | `string` | `'_repositories'` | 生成 repositories 文件名
-| globalFilename | `string` | 无 | 全局文件名 - 如果设置所有表将继承于此 - 例如设置为：'_global' - 如果文件不存在则自动创建
-| bindQuery | `string` | 无 | 绑定 Query 对象 - 设置 query 源，格式: 'QueryParam@filename' 例如: 'pool@../db'
-| generateRepositories | `boolean` | `false` | 是否生成 Repositories 类 - 通常用于多租户模式做数据库前置绑定 `Query` 对象
-| declareRepositoriesToModules | `string[]` | 无 | 是否需将 Repositories 实例定义到目标模块中 - 例如: `["@zenweb/core.Core.repositories"]`
-| filter | `string` | 无 | 表过滤规则正则
-| include | `string` | 无 | 表包含规则正则
+# ZenORM Generate
+
+[ZenORM](https://www.npmjs.com/package/zenorm) Table Structure Code Generation Tool
+
+表结构代码生成工具
+
+## Generate Config - 代码生成配置
+
+| 配置项 | 类型 | 默认值 | 说明
+| ----- | --- | ----- | ----
+| host | `string` | 无 | 目标数据库地址
+| port | `number` | 无 | 数据库端口
+| user | `string` | 无 | 数据库用户名
+| password | `string` | 无 | 数据库密码
+| database | `string` | 无 | 数据库名
+| outputDir | `string` | `'./src/model'` | 代码输出目录
+| tablesFilename | `string` | `'_tables'` | 生成数据库表结构文件名
+| repositoriesFilename | `string` | `'_repositories'` | 生成 repositories 文件名
+| globalFilename | `string` | 无 | 全局文件名 - 如果设置所有表将继承于此 - 例如设置为：'_global' - 如果文件不存在则自动创建
+| bindQuery | `boolean` | `false` | repositories 文件生成 bindQuery(query: QueryParam) 方法用于设置模型的 Query 源 - 并生成模型的静态 Repository 方法
+| generateRepositories | `boolean` | `false` | 是否生成 Repositories 类 - 通常用于多租户模式做数据库前置绑定 `Query` 对象
+| declareRepositoriesToModules | `string[]` | 无 | 是否需将 Repositories 实例定义到目标模块中 - 例如: `["@zenweb/core.Core.repositories"]`
+| filter | `string` | 无 | 表过滤规则正则
+| include | `string` | 无 | 表包含规则正则

package/dist/bin/zenorm-generate.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};

package/dist/bin/zenorm-generate.js

@@ -1,27 +1,27 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = require("path");
-const generate_1 = require("../generate");
-function getConfig(filename) {
-    const configFile = path.join(process.cwd(), filename);
-    const config = require(configFile);
-    return Object.assign({
-        backend: '@zenorm/generate-mysql',
-    }, config);
-}
-async function main(configFilename) {
-    const config = await getConfig(configFilename);
-    const call = require(config.backend).default;
-    await (0, generate_1.generate)(call()(config), config);
-}
-if (!process.argv[2]) {
-    console.log('zenorm-generate config.json');
-    process.exit(1);
-}
-else {
-    main(process.argv[2]).then(() => process.exit(), e => {
-        console.error(e);
-        process.exit(1);
-    });
-}
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
+const generate_1 = require("../generate");
+function getConfig(filename) {
+    const configFile = path.join(process.cwd(), filename);
+    const config = require(configFile);
+    return Object.assign({
+        backend: '@zenorm/generate-mysql',
+    }, config);
+}
+async function main(configFilename) {
+    const config = await getConfig(configFilename);
+    const call = require(config.backend).default;
+    await (0, generate_1.generate)(call()(config), config);
+}
+if (!process.argv[2]) {
+    console.log('zenorm-generate config.json');
+    process.exit(1);
+}
+else {
+    main(process.argv[2]).then(() => process.exit(), e => {
+        console.error(e);
+        process.exit(1);
+    });
+}

package/dist/generate.d.ts

@@ -1,2 +1,2 @@
-import { GenerateConfig, TabelDescribe } from './types';
-export declare function generate(tables: AsyncGenerator<TabelDescribe>, cfg?: GenerateConfig): Promise<void>;
+import { GenerateConfig, TabelDescribe } from './types';
+export declare function generate(tables: AsyncGenerator<TabelDescribe>, cfg?: GenerateConfig): Promise<void>;

package/dist/generate.js

@@ -1,164 +1,166 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
-const fs_1 = require("fs");
-const path = require("path");
-const pascal_case_1 = require("pascal-case");
-const snake_case_1 = require("snake-case");
-const utils_1 = require("./utils");
-const zenormName = process.env.ZENORM_NAME || 'zenorm';
-async function generate(tables, cfg) {
-    console.log('generate models...');
-    const config = Object.assign({
-        outputDir: './src/model',
-        tablesFilename: '_tables',
-        repositoriesFilename: '_repositories',
-    }, cfg);
-    const outputDir = (0, utils_1.cwdPath)(config.outputDir);
-    await (0, utils_1.checkFileDir)(outputDir);
-    console.log('database:', config.database);
-    const remark = [
-        '// zenorm 自动生成文件',
-        '// 请不要修改此文件，因为此文件在每次重新生成数据库结构时会被覆盖',
-        `// create at: ${(0, utils_1.currentDatetime)()}`,
-        `// create by: ${process.env.USER || process.env.USERNAME || '-'}@${process.env.COMPUTERNAME || '-'}`,
-        `// database: ${config.database}`,
-    ];
-    const structs = [
-        ...remark,
-        config.globalFilename ? `import _Global from './${config.globalFilename}';` : null,
-        '',
-    ];
-    const models = [];
-    const filterRegExp = config.filter ? new RegExp(config.filter) : null;
-    const includeRegExp = config.include ? new RegExp(config.include) : null;
-    for await (const t of tables) {
-        const tableName = t.name;
-        if ((filterRegExp && filterRegExp.test(tableName))
-            || (includeRegExp && !includeRegExp.test(tableName))) {
-            // console.log('table:', tableName, 'ignore');
-            continue;
-        }
-        const className = (0, pascal_case_1.pascalCase)(tableName);
-        const name = (0, snake_case_1.snakeCase)(tableName);
-        const outputFilename = path.join(outputDir, name + '.ts');
-        console.log('table:', tableName);
-        let pk = 'id';
-        let pkType = 'number';
-        const props = [];
-        const columns = [];
-        for (const c of t.columns) {
-            if (c.pk) {
-                pk = c.name;
-                pkType = c.type;
-            }
-            if (c.comment && c.comment.length) {
-                props.push(`  /**`);
-                for (const line of c.comment) {
-                    props.push(`   * ${line}`);
-                }
-                props.push(`   */`);
-            }
-            props.push(`  ${c.name}${c.required ? '!' : '?'}: ${c.type};`);
-            columns.push(c.name);
-        }
-        structs.push(`export class ${className}Table${config.globalFilename ? ' extends _Global' : ''} {`);
-        structs.push(`  static columns = ${JSON.stringify(columns)};`);
-        structs.push(...props);
-        structs.push('}');
-        structs.push('');
-        // model class
-        await (0, utils_1.notExistsPut)(outputFilename, () => {
-            return [
-                `import { model } from '${zenormName}';`,
-                `import { ${className}Table } from './${config.tablesFilename}';`,
-                '',
-                `@model({`,
-                `  pk: '${pk}',`,
-                name != tableName ? `  name: '${name}',` : null,
-                `  table: '${tableName}',`,
-                `})`,
-                `export default class ${className} extends ${className}Table {`,
-                `}`,
-                '',
-            ].filter(i => i !== null).join('\n');
-        });
-        models.push({ name, className, pkType });
-    }
-    const tablesFilename = path.join(outputDir, config.tablesFilename + '.ts');
-    console.log(`write tables file: ${tablesFilename}`);
-    await fs_1.promises.writeFile(tablesFilename, structs.filter(i => i !== null).join('\n'));
-    const repositories = [
-        ...remark,
-        `import { ${config.generateRepositories ? `QueryParam, ` : ''}createRepositoryQuery } from '${zenormName}';`,
-        ...models.map(({ name, className }) => `import _${className} from './${name}';`),
-    ];
-    // 绑定静态 Query
-    if (config.bindQuery) {
-        const [v, p] = config.bindQuery.split('@', 2);
-        repositories.push(`import { ${v} as _query } from '${p}';`);
-    }
-    // static
-    models.forEach(({ className, pkType }) => {
-        repositories.push('', `export class ${className} extends _${className} {`, `  /** 使用指定 Query 对象查询 ${className}Repository */`, `  static query = createRepositoryQuery<${className}, ${pkType}>(${className});`);
-        if (config.bindQuery) {
-            repositories.push(`  /** Query 绑定的 ${className}Repository */`);
-            repositories.push(`  static repository = ${className}.query(_query);`);
-            repositories.push(...[
-                'of',
-                'find',
-                'findByPk',
-                'getByPk',
-                'count',
-                'exists',
-                'create',
-                'createAndGet',
-            ].map(i => `  static ${i}: typeof ${className}.repository.${i} = ${className}.repository.${i}.bind(${className}.repository);`));
-            // 实例方法
-            repositories.push(`  /** 保存当前实例数据 */`);
-            repositories.push(`  save() { return ${className}.repository.save(this); }`);
-            repositories.push(`  /** 更新当前实例数据 */`);
-            repositories.push(`  update(data: Partial<${className}>) { return ${className}.repository.update(this, data); }`);
-            repositories.push(`  /** 删除当前实例数据 */`);
-            repositories.push(`  delete() { return ${className}.repository.delete(this); }`);
-        }
-        repositories.push('}');
-    });
-    // Repositories
-    if (config.generateRepositories) {
-        repositories.push('', `export class Repositories {`, `  constructor(private _query: QueryParam) {}`, ...models.map(({ className }) => `  get ${className}Repository() { return ${className}.query(this._query); }`), `}`, '');
-        // 添加 Repositories 到目标模块中
-        if (config.declareRepositoriesToModules) {
-            for (const mod of config.declareRepositoriesToModules) {
-                const _m = mod.split('.');
-                repositories.push(`declare module '${_m[0]}' {`);
-                repositories.push(`  interface ${_m.slice(1, -1).join('.')} {`);
-                repositories.push(`    ${_m[_m.length - 1]}: Repositories;`);
-                repositories.push(`  }`);
-                repositories.push(`}`);
-                repositories.push(``);
-            }
-        }
-    }
-    const repositoriesFilename = path.join(outputDir, config.repositoriesFilename + '.ts');
-    console.log(`write repositories file: ${repositoriesFilename}`);
-    await fs_1.promises.writeFile(repositoriesFilename, repositories.join('\n'));
-    // 生成 global.ts
-    if (config.globalFilename) {
-        const globalFilename = path.join(outputDir, config.globalFilename + '.ts');
-        await (0, utils_1.notExistsPut)(globalFilename, () => {
-            console.log(`write file: ${globalFilename}`);
-            return 'export default class Global {}';
-        });
-    }
-    // 生成 index.ts
-    const indexFilename = path.join(outputDir, 'index.ts');
-    await (0, utils_1.notExistsPut)(indexFilename, () => {
-        console.log(`write file: ${indexFilename}`);
-        return [
-            `export * from './${config.tablesFilename}';`,
-            `export * from './${config.repositoriesFilename}';`,
-        ].join('\n');
-    });
-}
-exports.generate = generate;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const fs_1 = require("fs");
+const path = require("path");
+const pascal_case_1 = require("pascal-case");
+const snake_case_1 = require("snake-case");
+const utils_1 = require("./utils");
+const zenormName = process.env.ZENORM_NAME || 'zenorm';
+async function generate(tables, cfg) {
+    console.log('generate models...');
+    const config = Object.assign({
+        outputDir: './src/model',
+        tablesFilename: '_tables',
+        repositoriesFilename: '_repositories',
+    }, cfg);
+    const outputDir = (0, utils_1.cwdPath)(config.outputDir);
+    await (0, utils_1.checkFileDir)(outputDir);
+    console.log('database:', config.database);
+    const remark = [
+        '// zenorm 自动生成文件',
+        '// 请不要修改此文件，因为此文件在每次重新生成数据库结构时会被覆盖',
+        `// create at: ${(0, utils_1.currentDatetime)()}`,
+        `// create by: ${process.env.USER || process.env.USERNAME || '-'}@${process.env.COMPUTERNAME || '-'}`,
+        `// database: ${config.database}`,
+    ];
+    const structs = [
+        ...remark,
+        config.globalFilename ? `import _Global from './${config.globalFilename}';` : null,
+        '',
+    ];
+    const models = [];
+    const filterRegExp = config.filter ? new RegExp(config.filter) : null;
+    const includeRegExp = config.include ? new RegExp(config.include) : null;
+    for await (const t of tables) {
+        const tableName = t.name;
+        if ((filterRegExp && filterRegExp.test(tableName))
+            || (includeRegExp && !includeRegExp.test(tableName))) {
+            // console.log('table:', tableName, 'ignore');
+            continue;
+        }
+        const className = (0, pascal_case_1.pascalCase)(tableName);
+        const name = (0, snake_case_1.snakeCase)(tableName);
+        const outputFilename = path.join(outputDir, name + '.ts');
+        console.log('table:', tableName);
+        let pk = 'id';
+        let pkType = 'number';
+        const props = [];
+        const columns = [];
+        for (const c of t.columns) {
+            if (c.pk) {
+                pk = c.name;
+                pkType = c.type;
+            }
+            if (c.comment && c.comment.length) {
+                props.push(`  /**`);
+                for (const line of c.comment) {
+                    props.push(`   * ${line}`);
+                }
+                props.push(`   */`);
+            }
+            props.push(`  ${c.name}${c.required ? '!' : '?'}: ${c.type};`);
+            columns.push(c.name);
+        }
+        structs.push(`export class ${className}Table${config.globalFilename ? ' extends _Global' : ''} {`);
+        structs.push(`  static columns = ${JSON.stringify(columns)};`);
+        structs.push(...props);
+        structs.push('}');
+        structs.push('');
+        // model class
+        await (0, utils_1.notExistsPut)(outputFilename, () => {
+            return [
+                `import { model } from '${zenormName}';`,
+                `import { ${className}Table } from './${config.tablesFilename}';`,
+                '',
+                `@model({`,
+                `  pk: '${pk}',`,
+                name != tableName ? `  name: '${name}',` : null,
+                `  table: '${tableName}',`,
+                `})`,
+                `export default class ${className} extends ${className}Table {`,
+                `}`,
+                '',
+            ].filter(i => i !== null).join('\n');
+        });
+        models.push({ name, className, pkType });
+    }
+    const tablesFilename = path.join(outputDir, config.tablesFilename + '.ts');
+    console.log(`write tables file: ${tablesFilename}`);
+    await fs_1.promises.writeFile(tablesFilename, structs.filter(i => i !== null).join('\n'));
+    const repositories = [
+        ...remark,
+        `import { ${(config.generateRepositories || config.bindQuery) ? `QueryParam, ` : ''}createRepositoryQuery } from '${zenormName}';`,
+        ...models.map(({ name, className }) => `import _${className} from './${name}';`),
+    ];
+    // 绑定静态 Query
+    if (config.bindQuery) {
+        repositories.push('', `let _bindQuery: QueryParam;`, `function _query() { return typeof _bindQuery === 'function' ? _bindQuery() : _bindQuery }`, `/** 绑定模型 Query 源 */`, `export function bindQuery(query: QueryParam) { _bindQuery = query; }`);
+    }
+    // static
+    models.forEach(({ className, pkType }) => {
+        repositories.push('', `export class ${className} extends _${className} {`, `  /** 使用指定 Query 对象查询 ${className}Repository */`, `  static query = createRepositoryQuery<${className}, ${pkType}>(${className});`);
+        if (config.bindQuery) {
+            repositories.push(`  /** Query 绑定的 ${className}Repository */`);
+            repositories.push(`  static repository = ${className}.query(_query);`);
+            repositories.push(...[
+                'of',
+                'find',
+                'findByPk',
+                'getByPk',
+                'count',
+                'exists',
+                'create',
+                'createAndGet',
+                'save',
+                'update',
+                'delete',
+            ].map(i => `  static ${i}: typeof ${className}.repository.${i} = ${className}.repository.${i}.bind(${className}.repository);`));
+            // 实例方法
+            repositories.push(`  /** 保存当前实例数据 */`);
+            repositories.push(`  save() { return ${className}.repository.save(this); }`);
+            repositories.push(`  /** 更新当前实例数据 */`);
+            repositories.push(`  update(data: Partial<${className}>) { return ${className}.repository.update(this, data); }`);
+            repositories.push(`  /** 删除当前实例数据 */`);
+            repositories.push(`  delete() { return ${className}.repository.delete(this); }`);
+        }
+        repositories.push('}');
+    });
+    // Repositories
+    if (config.generateRepositories) {
+        repositories.push('', `export class Repositories {`, `  constructor(private _query: QueryParam) {}`, ...models.map(({ className }) => `  get ${className}Repository() { return ${className}.query(this._query); }`), `}`, '');
+        // 添加 Repositories 到目标模块中
+        if (config.declareRepositoriesToModules) {
+            for (const mod of config.declareRepositoriesToModules) {
+                const _m = mod.split('.');
+                repositories.push(`declare module '${_m[0]}' {`);
+                repositories.push(`  interface ${_m.slice(1, -1).join('.')} {`);
+                repositories.push(`    ${_m[_m.length - 1]}: Repositories;`);
+                repositories.push(`  }`);
+                repositories.push(`}`);
+                repositories.push(``);
+            }
+        }
+    }
+    const repositoriesFilename = path.join(outputDir, config.repositoriesFilename + '.ts');
+    console.log(`write repositories file: ${repositoriesFilename}`);
+    await fs_1.promises.writeFile(repositoriesFilename, repositories.join('\n'));
+    // 生成 global.ts
+    if (config.globalFilename) {
+        const globalFilename = path.join(outputDir, config.globalFilename + '.ts');
+        await (0, utils_1.notExistsPut)(globalFilename, () => {
+            console.log(`write file: ${globalFilename}`);
+            return 'export default class Global {}';
+        });
+    }
+    // 生成 index.ts
+    const indexFilename = path.join(outputDir, 'index.ts');
+    await (0, utils_1.notExistsPut)(indexFilename, () => {
+        console.log(`write file: ${indexFilename}`);
+        return [
+            `export * from './${config.tablesFilename}';`,
+            `export * from './${config.repositoriesFilename}';`,
+        ].join('\n');
+    });
+}
+exports.generate = generate;

package/dist/index.d.ts

@@ -1 +1 @@
-export * from './types';
+export * from './types';

package/dist/index.js

@@ -1,17 +1,17 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -1,120 +1,121 @@
-/**
- * 模型文件生成 - 列描述
- */
-export interface ColumnDescribe {
-    /**
-     * 是否为主键
-     */
-    pk: boolean;
-    /**
-     * 列名称
-     */
-    name: string;
-    /**
-     * 列类型，例如 number, string, boolean
-     */
-    type: string;
-    /**
-     * 是否为必须项（非NULL）
-     */
-    required: boolean;
-    /**
-     * 注释信息，一行一条
-     */
-    comment: string[];
-}
-/**
- * 模型文件生成 - 表描述
- */
-export interface TabelDescribe {
-    /**
-     * 表名称
-     */
-    name: string;
-    /**
-     * 列描述信息
-     */
-    columns: ColumnDescribe[];
-}
-/**
- * 生成配置
- */
-export interface GenerateConfig {
-    /**
-     * 目标数据库地址
-     */
-    host?: string;
-    /**
-     * 数据库端口
-     */
-    port?: number;
-    /**
-     * 数据库用户名
-     */
-    user?: string;
-    /**
-     * 数据库密码
-     */
-    password?: string;
-    /**
-     * 数据库名
-     */
-    database?: string;
-    /**
-     * 代码输出目录
-     * @default './src/model'
-     */
-    outputDir?: string;
-    /**
-     * 生成数据库表结构文件名
-     * - 此文件每次生成都会被重新改写
-     * @default '_tables'
-     */
-    tablesFilename?: string;
-    /**
-     * 生成 repositories 文件名
-     * - 此文件每次生成都会被重新改写
-     * @default '_repositories'
-     */
-    repositoriesFilename?: string;
-    /**
-     * 全局文件名
-     * - 例如设置为：'_global'
-     * - 如果设置所有表将继承于此
-     * - 如果文件不存在则自动创建
-     */
-    globalFilename?: string;
-    /**
-     * 绑定 Query 对象
-     * - 设置 query 源，格式: 'QueryParam@filename' 例如: 'pool@../db'
-     * - 生成模型的静态 Repository 方法
-     * - 对于多租户数据库系统不适用
-     */
-    bindQuery?: string;
-    /**
-     * 是否生成 Repositories 类
-     * - 通常用于多租户模式做数据库前置绑定 `Query` 对象
-     * @default false
-     */
-    generateRepositories?: boolean;
-    /**
-     * 是否需将 Repositories 实例定义到目标模块中
-     * - 例如: `["@zenweb/core.Core.repositories"]`
-     * - 需要启用: `generateRepositories`
-     * @default undefined
-     */
-    declareRepositoriesToModules?: string[];
-    /**
-     * 表过滤规则正则，默认不处理
-     */
-    filter?: string;
-    /**
-     * 表包含规则正则，默认不处理
-     */
-    include?: string;
-}
-/**
- * 数据库表信息生成方法
- * - 返回表描述的处理方法
- */
-export type GenerateFunction = (config: GenerateConfig) => AsyncGenerator<TabelDescribe>;
+/**
+ * 模型文件生成 - 列描述
+ */
+export interface ColumnDescribe {
+    /**
+     * 是否为主键
+     */
+    pk: boolean;
+    /**
+     * 列名称
+     */
+    name: string;
+    /**
+     * 列类型，例如 number, string, boolean
+     */
+    type: string;
+    /**
+     * 是否为必须项（非NULL）
+     */
+    required: boolean;
+    /**
+     * 注释信息，一行一条
+     */
+    comment: string[];
+}
+/**
+ * 模型文件生成 - 表描述
+ */
+export interface TabelDescribe {
+    /**
+     * 表名称
+     */
+    name: string;
+    /**
+     * 列描述信息
+     */
+    columns: ColumnDescribe[];
+}
+/**
+ * 生成配置
+ */
+export interface GenerateConfig {
+    /**
+     * 目标数据库地址
+     */
+    host?: string;
+    /**
+     * 数据库端口
+     */
+    port?: number;
+    /**
+     * 数据库用户名
+     */
+    user?: string;
+    /**
+     * 数据库密码
+     */
+    password?: string;
+    /**
+     * 数据库名
+     */
+    database?: string;
+    /**
+     * 代码输出目录
+     * @default './src/model'
+     */
+    outputDir?: string;
+    /**
+     * 生成数据库表结构文件名
+     * - 此文件每次生成都会被重新改写
+     * @default '_tables'
+     */
+    tablesFilename?: string;
+    /**
+     * 生成 repositories 文件名
+     * - 此文件每次生成都会被重新改写
+     * @default '_repositories'
+     */
+    repositoriesFilename?: string;
+    /**
+     * 全局文件名
+     * - 例如设置为：'_global'
+     * - 如果设置所有表将继承于此
+     * - 如果文件不存在则自动创建
+     */
+    globalFilename?: string;
+    /**
+     * 绑定 Query 对象
+     * - repositories 文件生成 bindQuery(query: QueryParam) 方法用于设置模型的 Query 源
+     * - 并生成模型的静态 Repository 方法
+     * - 对于多租户多数据库系统不适用
+     * @default false
+     */
+    bindQuery?: boolean;
+    /**
+     * 是否生成 Repositories 类
+     * - 通常用于多租户模式做数据库前置绑定 `Query` 对象
+     * @default false
+     */
+    generateRepositories?: boolean;
+    /**
+     * 是否需将 Repositories 实例定义到目标模块中
+     * - 例如: `["@zenweb/core.Core.repositories"]`
+     * - 需要启用: `generateRepositories`
+     * @default undefined
+     */
+    declareRepositoriesToModules?: string[];
+    /**
+     * 表过滤规则正则，默认不处理
+     */
+    filter?: string;
+    /**
+     * 表包含规则正则，默认不处理
+     */
+    include?: string;
+}
+/**
+ * 数据库表信息生成方法
+ * - 返回表描述的处理方法
+ */
+export type GenerateFunction = (config: GenerateConfig) => AsyncGenerator<TabelDescribe>;

package/dist/types.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -1,10 +1,10 @@
-export declare function cwdPath(p: string): string;
-export declare function checkFileDir(dir: string): Promise<void>;
-export declare function fileExists(f: string): Promise<boolean>;
-/**
- * 文件不存在则创建并写入内容
- * @param filename
- * @param getContent
- */
-export declare function notExistsPut(filename: string, getContent: () => string | Promise<string>): Promise<boolean>;
-export declare function currentDatetime(): string;
+export declare function cwdPath(p: string): string;
+export declare function checkFileDir(dir: string): Promise<void>;
+export declare function fileExists(f: string): Promise<boolean>;
+/**
+ * 文件不存在则创建并写入内容
+ * @param filename
+ * @param getContent
+ */
+export declare function notExistsPut(filename: string, getContent: () => string | Promise<string>): Promise<boolean>;
+export declare function currentDatetime(): string;

package/dist/utils.js

@@ -1,37 +1,37 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.currentDatetime = exports.notExistsPut = exports.fileExists = exports.checkFileDir = exports.cwdPath = void 0;
-const fs_1 = require("fs");
-const path = require("path");
-function cwdPath(p) {
-    if (p.startsWith('./')) {
-        return path.join(process.cwd(), p.slice(2));
-    }
-    return p;
-}
-exports.cwdPath = cwdPath;
-function checkFileDir(dir) {
-    return fs_1.promises.mkdir(dir, { recursive: true });
-}
-exports.checkFileDir = checkFileDir;
-function fileExists(f) {
-    return fs_1.promises.access(f).then(() => true, e => false);
-}
-exports.fileExists = fileExists;
-/**
- * 文件不存在则创建并写入内容
- * @param filename
- * @param getContent
- */
-async function notExistsPut(filename, getContent) {
-    if (!await fileExists(filename)) {
-        await fs_1.promises.writeFile(filename, await getContent());
-        return true;
-    }
-    return false;
-}
-exports.notExistsPut = notExistsPut;
-function currentDatetime() {
-    return new Date().toLocaleString();
-}
-exports.currentDatetime = currentDatetime;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.currentDatetime = exports.notExistsPut = exports.fileExists = exports.checkFileDir = exports.cwdPath = void 0;
+const fs_1 = require("fs");
+const path = require("path");
+function cwdPath(p) {
+    if (p.startsWith('./')) {
+        return path.join(process.cwd(), p.slice(2));
+    }
+    return p;
+}
+exports.cwdPath = cwdPath;
+function checkFileDir(dir) {
+    return fs_1.promises.mkdir(dir, { recursive: true });
+}
+exports.checkFileDir = checkFileDir;
+function fileExists(f) {
+    return fs_1.promises.access(f).then(() => true, e => false);
+}
+exports.fileExists = fileExists;
+/**
+ * 文件不存在则创建并写入内容
+ * @param filename
+ * @param getContent
+ */
+async function notExistsPut(filename, getContent) {
+    if (!await fileExists(filename)) {
+        await fs_1.promises.writeFile(filename, await getContent());
+        return true;
+    }
+    return false;
+}
+exports.notExistsPut = notExistsPut;
+function currentDatetime() {
+    return new Date().toLocaleString();
+}
+exports.currentDatetime = currentDatetime;

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/README.md

@@ -0,0 +1,9 @@
+@zenorm/generate / [Exports](modules.md)
+
+# ZenORM Generate
+
+[ZenORM](https://www.npmjs.com/package/zenorm) Table Structure Code Generation Tool
+
+[Generate Config](docs/interfaces/GenerateConfig.md)
+
+[API Documents](docs/modules.md)

package/docs/interfaces/ColumnDescribe.md

@@ -0,0 +1,55 @@
+[@zenorm/generate](../README.md) / [Exports](../modules.md) / ColumnDescribe
+
+# Interface: ColumnDescribe
+
+模型文件生成 - 列描述
+
+## Table of contents
+
+### Properties
+
+- [comment](ColumnDescribe.md#comment)
+- [name](ColumnDescribe.md#name)
+- [pk](ColumnDescribe.md#pk)
+- [required](ColumnDescribe.md#required)
+- [type](ColumnDescribe.md#type)
+
+## Properties
+
+### comment
+
+• **comment**: `string`[]
+
+注释信息，一行一条
+
+___
+
+### name
+
+• **name**: `string`
+
+列名称
+
+___
+
+### pk
+
+• **pk**: `boolean`
+
+是否为主键
+
+___
+
+### required
+
+• **required**: `boolean`
+
+是否为必须项（非NULL）
+
+___
+
+### type
+
+• **type**: `string`
+
+列类型，例如 number, string, boolean

package/docs/interfaces/GenerateConfig.md

@@ -0,0 +1,157 @@
+[@zenorm/generate](../README.md) / [Exports](../modules.md) / GenerateConfig
+
+# Interface: GenerateConfig
+
+生成配置
+
+## Table of contents
+
+### Properties
+
+- [database](GenerateConfig.md#database)
+- [declareRepositoriesToModules](GenerateConfig.md#declarerepositoriestomodules)
+- [filter](GenerateConfig.md#filter)
+- [generateRepositories](GenerateConfig.md#generaterepositories)
+- [globalFilename](GenerateConfig.md#globalfilename)
+- [host](GenerateConfig.md#host)
+- [include](GenerateConfig.md#include)
+- [outputDir](GenerateConfig.md#outputdir)
+- [password](GenerateConfig.md#password)
+- [port](GenerateConfig.md#port)
+- [repositoriesFilename](GenerateConfig.md#repositoriesfilename)
+- [tablesFilename](GenerateConfig.md#tablesfilename)
+- [user](GenerateConfig.md#user)
+
+## Properties
+
+### database
+
+• `Optional` **database**: `string`
+
+数据库名
+
+___
+
+### declareRepositoriesToModules
+
+• `Optional` **declareRepositoriesToModules**: `string`[]
+
+是否需将 Repositories 实例定义到目标模块中
+- 例如: `["@zenweb/core.Core.repositories"]`
+- 需要: `generateRepositories: true`
+
+**`Default`**
+
+undefined
+
+___
+
+### filter
+
+• `Optional` **filter**: `string`
+
+表过滤规则正则，默认不处理
+
+___
+
+### generateRepositories
+
+• `Optional` **generateRepositories**: `boolean`
+
+是否生成 Repositories 类
+- 通常用于多租户环境需要做模型前置绑定 `Query` 对象
+
+**`Default`**
+
+false
+
+___
+
+### globalFilename
+
+• `Optional` **globalFilename**: `string`
+
+全局文件名
+- 如果不存在生成
+
+**`Default`**
+
+'_global'
+
+___
+
+### host
+
+• `Optional` **host**: `string`
+
+目标数据库地址
+
+___
+
+### include
+
+• `Optional` **include**: `string`
+
+表包含规则正则，默认不处理
+
+___
+
+### outputDir
+
+• `Optional` **outputDir**: `string`
+
+代码输出目录
+
+**`Default`**
+
+'./src/model'
+
+___
+
+### password
+
+• `Optional` **password**: `string`
+
+数据库密码
+
+___
+
+### port
+
+• `Optional` **port**: `number`
+
+数据库端口
+
+___
+
+### repositoriesFilename
+
+• `Optional` **repositoriesFilename**: `string`
+
+生成 repositories 文件名
+- 此文件每次生成都会被重新改写
+
+**`Default`**
+
+'_repositories'
+
+___
+
+### tablesFilename
+
+• `Optional` **tablesFilename**: `string`
+
+生成数据库表结构文件名
+- 此文件每次生成都会被重新改写
+
+**`Default`**
+
+'_tables'
+
+___
+
+### user
+
+• `Optional` **user**: `string`
+
+数据库用户名

package/docs/interfaces/TabelDescribe.md

@@ -0,0 +1,28 @@
+[@zenorm/generate](../README.md) / [Exports](../modules.md) / TabelDescribe
+
+# Interface: TabelDescribe
+
+模型文件生成 - 表描述
+
+## Table of contents
+
+### Properties
+
+- [columns](TabelDescribe.md#columns)
+- [name](TabelDescribe.md#name)
+
+## Properties
+
+### columns
+
+• **columns**: [`ColumnDescribe`](ColumnDescribe.md)[]
+
+列描述信息
+
+___
+
+### name
+
+• **name**: `string`
+
+表名称

package/docs/modules.md

@@ -0,0 +1,38 @@
+[@zenorm/generate](README.md) / Exports
+
+# @zenorm/generate
+
+## Table of contents
+
+### Interfaces
+
+- [ColumnDescribe](interfaces/ColumnDescribe.md)
+- [GenerateConfig](interfaces/GenerateConfig.md)
+- [TabelDescribe](interfaces/TabelDescribe.md)
+
+### Type Aliases
+
+- [GenerateFunction](modules.md#generatefunction)
+
+## Type Aliases
+
+### GenerateFunction
+
+Ƭ **GenerateFunction**: (`config`: [`GenerateConfig`](interfaces/GenerateConfig.md)) => `AsyncGenerator`<[`TabelDescribe`](interfaces/TabelDescribe.md)\>
+
+#### Type declaration
+
+▸ (`config`): `AsyncGenerator`<[`TabelDescribe`](interfaces/TabelDescribe.md)\>
+
+数据库表信息生成方法
+- 返回表描述的处理方法
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `config` | [`GenerateConfig`](interfaces/GenerateConfig.md) |
+
+##### Returns
+
+`AsyncGenerator`<[`TabelDescribe`](interfaces/TabelDescribe.md)\>

package/package.json

@@ -1,45 +1,45 @@
-{
-  "name": "@zenorm/generate",
-  "description": "Easy ORM, easy query. easy typing! Auto generate typescript declaration.",
-  "version": "1.1.1",
-  "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "repository": "https://github.com/yefei/zenorm-generate",
-  "author": "YeFei <316606233@qq.com>",
-  "license": "MIT",
-  "bin": {
-    "zenorm-generate": "./dist/bin/zenorm-generate.js"
-  },
-  "files": [
-    "docs",
-    "dist"
-  ],
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "prepublishOnly": "npm run build",
-    "gen": "cd test && ts-node ../src/bin/zenorm-generate.ts config.json",
-    "t1": "cd test && cross-env DEBUG=* ts-node t1"
-  },
-  "keywords": [
-    "mysql",
-    "query",
-    "model",
-    "types",
-    "generate",
-    "database"
-  ],
-  "devDependencies": {
-    "@types/node": "^12.20.41",
-    "@zenorm/generate-mysql": "^1.2.0",
-    "cross-env": "^7.0.3",
-    "mysql-easy-query": "^3.12.0",
-    "rimraf": "^4.4.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.9.5",
-    "zenorm": "^3.27.0"
-  },
-  "dependencies": {
-    "pascal-case": "^3.1.2",
-    "snake-case": "^3.0.4"
-  }
-}
+{
+  "name": "@zenorm/generate",
+  "description": "Easy ORM, easy query. easy typing! Auto generate typescript declaration.",
+  "version": "1.3.0",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "repository": "https://github.com/yefei/zenorm-generate",
+  "author": "YeFei <316606233@qq.com>",
+  "license": "MIT",
+  "bin": {
+    "zenorm-generate": "./dist/bin/zenorm-generate.js"
+  },
+  "files": [
+    "docs",
+    "dist"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "prepublishOnly": "npm run build",
+    "gen": "cd test && ts-node ../src/bin/zenorm-generate.ts config.json",
+    "t1": "cd test && cross-env DEBUG=* ts-node t1"
+  },
+  "keywords": [
+    "mysql",
+    "query",
+    "model",
+    "types",
+    "generate",
+    "database"
+  ],
+  "devDependencies": {
+    "@types/node": "^12.20.41",
+    "@zenorm/generate-mysql": "^1.2.0",
+    "cross-env": "^7.0.3",
+    "mysql-easy-query": "^3.12.0",
+    "rimraf": "^4.4.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5",
+    "zenorm": "^3.27.0"
+  },
+  "dependencies": {
+    "pascal-case": "^3.1.2",
+    "snake-case": "^3.0.4"
+  }
+}