@zenorm/generate 2.2.0 → 2.4.0

package/README.md

@@ -4,6 +4,42 @@
 
 表结构代码生成工具
 
+## 安装
+```bash
+npm i -D @zenorm/generate
+```
+
+## 配置
+
+新建配置文件 `dbgen.config.js`
+
+```js
+/** @type {import("@zenorm/generate").GenerateConfig} */
+export default {
+  "database": "you_db_name",    // 数据库名
+  "host": "localhost",          // 目标数据库地址
+  "port": 3306,                 // 数据库端口
+  "user": "root",               // 数据库用户名
+  "password": "",               // 数据库密码
+  "outputDir": "./model/",      // 代码输出目录
+  "bindQuery": true,            // 绑定 Query 对象
+}
+```
+
+## 在 package.json 中添加命令
+```json
+{
+  "scripts": {
+    "dbgen": "zenorm-generate dbgen.config.js"
+  },
+}
+```
+
+## 运行命令生成数据库代码
+```bash
+npm run dbgen
+```
+
 ## Generate Config - 代码生成配置
 
 | 配置项 | 类型 | 默认值 | 说明
@@ -22,3 +58,4 @@
 | declareRepositoriesToModules | `string[]` | 无 | 是否需将 Repositories 实例定义到目标模块中 - 例如: `["@zenweb/core.Core.repositories"]`
 | filter | `string` | 无 | 表过滤规则正则
 | include | `string` | 无 | 表包含规则正则
+| esModule | `boolean` | 无 | 是否输出满足 ESM 导入文件名 （必须带有 .js 扩展名）

package/dist/bin/zenorm-generate.js

@@ -1,25 +1,62 @@
 #!/usr/bin/env node
-import path from 'node:path';
-import { pathToFileURL } from 'node:url';
-import { generate } from '../generate.js';
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+const generate_1 = require("../generate");
 async function getConfig(filename) {
-    const configFile = pathToFileURL(path.join(process.cwd(), filename)).href;
-    const config = (await import(configFile)).default;
+    const configFile = node_path_1.default.join(process.cwd(), filename);
+    const config = (await Promise.resolve(`${configFile}`).then(s => __importStar(require(s)))).default;
     return Object.assign({
         backend: '@zenorm/generate-mysql',
     }, config);
 }
 async function main(configFilename) {
     const config = await getConfig(configFilename);
-    const call = (await import(config.backend)).default;
-    await generate(call()(config), config);
+    const call = (await Promise.resolve(`${config.backend}`).then(s => __importStar(require(s)))).default;
+    await (0, generate_1.generate)(call()(config), config);
 }
 if (!process.argv[2]) {
     console.log('zenorm-generate config.js');
     process.exit(1);
 }
 else {
-    await main(process.argv[2]).then(() => {
+    main(process.argv[2]).then(() => {
         console.log('Done.');
         process.exit();
     }, e => {

package/dist/generate.d.ts

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

package/dist/generate.js

@@ -1,10 +1,16 @@
-import { promises as fs } from 'node:fs';
-import path from 'node:path';
-import { pascalCase } from 'pascal-case';
-import { snakeCase } from 'snake-case';
-import { checkFileDir, currentDatetime, cwdPath, notExistsPut } from './utils.js';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = generate;
+const node_fs_1 = require("node:fs");
+const node_path_1 = __importDefault(require("node: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';
-export async function generate(tables, cfg) {
+async function generate(tables, cfg) {
     console.log('generate models...');
     const config = Object.assign({
         outputDir: './src/model',
@@ -13,19 +19,20 @@ export async function generate(tables, cfg) {
         staticMethods: true,
         instanceMethods: true,
     }, cfg);
-    const outputDir = cwdPath(config.outputDir);
-    await checkFileDir(outputDir);
+    function importFilename(filename) {
+        return cfg?.esModule ? `${filename}.js` : filename;
+    }
+    const outputDir = (0, utils_1.cwdPath)(config.outputDir);
+    await (0, utils_1.checkFileDir)(outputDir);
     console.log('database:', config.database);
     const remark = [
         '// zenorm 自动生成文件',
         '// 请不要修改此文件，因为此文件在每次重新生成数据库结构时会被覆盖',
-        `// create at: ${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}.js';` : null,
+        config.globalFilename ? `import _Global from './${importFilename(config.globalFilename)}';` : null,
         '',
     ];
     const typesOut = {};
@@ -40,9 +47,9 @@ export async function generate(tables, cfg) {
             // console.log('table:', tableName, 'ignore');
             continue;
         }
-        const className = pascalCase(tableName);
-        const name = snakeCase(tableName);
-        const outputFilename = path.join(outputDir, name + '.ts');
+        const className = (0, pascal_case_1.pascalCase)(tableName);
+        const name = (0, snake_case_1.snakeCase)(tableName);
+        const outputFilename = node_path_1.default.join(outputDir, name + '.ts');
         console.log('table:', tableName);
         // 自定义类型
         Object.assign(typesOut, t.types);
@@ -78,10 +85,10 @@ export async function generate(tables, cfg) {
         tablesOut.push('}');
         tablesOut.push('');
         // model class
-        await notExistsPut(outputFilename, () => {
+        await (0, utils_1.notExistsPut)(outputFilename, () => {
             return [
                 `import { Model } from '${zenormName}';`,
-                `import { ${className}Table } from './${config.tablesFilename}.js';`,
+                `import { ${className}Table } from './${importFilename(config.tablesFilename)}';`,
                 '',
                 `@Model({`,
                 pk ? `  pk: '${pk}',` : null,
@@ -100,9 +107,9 @@ export async function generate(tables, cfg) {
         structs.push(`type ${tname} = ${typesOut[tname]};`);
     }
     structs.push(...tablesOut);
-    const tablesFilename = path.join(outputDir, config.tablesFilename + '.ts');
+    const tablesFilename = node_path_1.default.join(outputDir, config.tablesFilename + '.ts');
     console.log(`write tables file: ${tablesFilename}`);
-    await fs.writeFile(tablesFilename, structs.filter(i => i !== null).join('\n'));
+    await node_fs_1.promises.writeFile(tablesFilename, structs.filter(i => i !== null).join('\n'));
     const imports = ['createRepositoryQuery'];
     if (config.generateRepositories || config.bindQuery) {
         imports.push('QueryParam');
@@ -110,8 +117,8 @@ export async function generate(tables, cfg) {
     const repositories = [
         ...remark,
         `import { ${imports.join(', ')} } from '${zenormName}';`,
-        `import * as _tables from './${config.tablesFilename}.js';`,
-        ...models.map(({ name, className }) => `import _${className} from './${name}.js';`),
+        `import * as _tables from './${importFilename(config.tablesFilename)}';`,
+        ...models.map(({ name, className }) => `import _${className} from './${importFilename(name)}';`),
     ];
     // 绑定静态 Query
     if (config.bindQuery) {
@@ -168,24 +175,24 @@ export async function generate(tables, cfg) {
             }
         }
     }
-    const repositoriesFilename = path.join(outputDir, config.repositoriesFilename + '.ts');
+    const repositoriesFilename = node_path_1.default.join(outputDir, config.repositoriesFilename + '.ts');
     console.log(`write repositories file: ${repositoriesFilename}`);
-    await fs.writeFile(repositoriesFilename, repositories.join('\n'));
+    await node_fs_1.promises.writeFile(repositoriesFilename, repositories.join('\n'));
     // 生成 global.ts
     if (config.globalFilename) {
-        const globalFilename = path.join(outputDir, config.globalFilename + '.ts');
-        await notExistsPut(globalFilename, () => {
+        const globalFilename = node_path_1.default.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 notExistsPut(indexFilename, () => {
+    const indexFilename = node_path_1.default.join(outputDir, 'index.ts');
+    await (0, utils_1.notExistsPut)(indexFilename, () => {
         console.log(`write file: ${indexFilename}`);
         return [
-            `export * from './${config.tablesFilename}.js';`,
-            `export * from './${config.repositoriesFilename}.js';`,
+            `export * from './${importFilename(config.tablesFilename)}';`,
+            `export * from './${importFilename(config.repositoriesFilename)}';`,
         ].join('\n');
     });
 }

package/dist/index.d.ts

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

package/dist/index.js

@@ -1 +1,17 @@
-export * from './types.js';
+"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

@@ -129,6 +129,10 @@ export interface GenerateConfig {
      * 表包含规则正则，默认不处理
      */
     include?: string;
+    /**
+     * 是否输出满足 ESM 导入文件名 （必须带有 .js 扩展名）
+     */
+    esModule?: boolean;
 }
 /**
  * 数据库表信息生成方法

package/dist/types.js

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

package/dist/utils.js

@@ -1,29 +1,39 @@
-import { promises as fs } from 'node:fs';
-import path from 'node:path';
-export function cwdPath(p) {
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cwdPath = cwdPath;
+exports.checkFileDir = checkFileDir;
+exports.fileExists = fileExists;
+exports.notExistsPut = notExistsPut;
+exports.currentDatetime = currentDatetime;
+const node_fs_1 = require("node:fs");
+const node_path_1 = __importDefault(require("node:path"));
+function cwdPath(p) {
     if (p.startsWith('./')) {
-        return path.join(process.cwd(), p.slice(2));
+        return node_path_1.default.join(process.cwd(), p.slice(2));
     }
     return p;
 }
-export function checkFileDir(dir) {
-    return fs.mkdir(dir, { recursive: true });
+function checkFileDir(dir) {
+    return node_fs_1.promises.mkdir(dir, { recursive: true });
 }
-export function fileExists(f) {
-    return fs.access(f).then(() => true, () => false);
+function fileExists(f) {
+    return node_fs_1.promises.access(f).then(() => true, () => false);
 }
 /**
  * 文件不存在则创建并写入内容
  * @param filename
  * @param getContent
  */
-export async function notExistsPut(filename, getContent) {
+async function notExistsPut(filename, getContent) {
     if (!await fileExists(filename)) {
-        await fs.writeFile(filename, await getContent());
+        await node_fs_1.promises.writeFile(filename, await getContent());
         return true;
     }
     return false;
 }
-export function currentDatetime() {
+function currentDatetime() {
     return new Date().toLocaleString();
 }

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@zenorm/generate",
-  "type": "module",
   "description": "Easy ORM, easy query. easy typing! Auto generate typescript declaration.",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "homepage": "https://zenorm.node.ltd",
@@ -15,10 +14,10 @@
     "dist"
   ],
   "scripts": {
-    "build": "rimraf dist && tsc",
+    "build": "rimraf dist && tsc -p tsconfig.build.json",
     "prepack": "npm run build",
-    "gen": "cd test && node --loader ts-node/esm ../src/bin/zenorm-generate.ts config.js",
-    "t1": "cd test && cross-env DEBUG=* node --loader ts-node/esm t1.ts"
+    "gen": "cd test && node -r ts-node/register ../src/bin/zenorm-generate.ts config.js",
+    "t1": "cd test && cross-env DEBUG=* node -r ts-node/register t1.ts"
   },
   "keywords": [
     "mysql",
@@ -32,11 +31,11 @@
     "@types/node": "^16.18.126",
     "@zenorm/generate-mysql": "^2.2.1",
     "cross-env": "^7.0.3",
-    "mysql-easy-query": "^3.16.1",
+    "mysql-easy-query": "^4.1.0",
     "rimraf": "^4.4.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.3",
-    "zenorm": "^4.3.0"
+    "typescript": "^6.0.3",
+    "zenorm": "^4.5.0"
   },
   "dependencies": {
     "pascal-case": "^3.1.2",