@shys/crud 1.0.1-beta.1 → 1.0.1-beta.2

package/README.md

@@ -22,6 +22,51 @@ npx @shys/crud
 npx @shys/crud --module home --table sys_user --src ./src
 ```
 
+### 配置到 package.json
+
+在项目的 `package.json` 中添加 `scripts` 命令，方便团队成员快速使用：
+
+```json
+{
+  "scripts": {
+    "crud": "shys-crud",
+    "crud:entity": "shys-crud --only-entity",
+    "crud:dry": "shys-crud --dry-run",
+    "crud:user": "shys-crud --module system --table sys_user --force",
+    "crud:order": "shys-crud --module order --table order_info --force"
+  },
+  "devDependencies": {
+    "@shys/crud": "^1.0.0"
+  }
+}
+```
+
+配置后使用方式：
+
+```bash
+# 交互式运行（推荐，可按需填写参数）
+npm run crud
+
+# 只生成 entity
+npm run crud:entity
+
+# 模拟运行预览（不实际写文件）
+npm run crud:dry
+
+# 生成指定表的完整 CRUD（已预定义 module 和 table）
+npm run crud:user
+npm run crud:order
+```
+
+如果使用 pnpm：
+
+```bash
+pnpm crud
+pnpm crud:user
+```
+
+> **提示**：推荐将常用的表配置成独立脚本（如上面的 `crud:user`、`crud:order`），配合 `--force` 可直接覆盖重新生成，配合 `crud.config.ts` 配置文件使用体验更佳。
+
 生成的目录结构：
 
 ```
@@ -108,6 +153,29 @@ export default {
 };
 ```
 
+### 配置字段说明
+
+| 字段 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `baseSrcPath` | `string` | `./src` | Midway 项目的 src 根目录绝对或相对路径。生成的模块文件将放在此目录下的 `modules/` 中。 |
+| `outputPath` | `string` | 与 `baseSrcPath` 相同 | 生成文件的输出路径。如需将代码生成到其他目录（如临时目录），可单独指定此项。 |
+| `moduleName` | `string` | 交互式询问 | 业务模块名，用于组织目录结构，如 `home`、`order`、`goods`。 |
+| `tableName` | `string` | 交互式询问 | 数据库表名，如 `sys_user`、`city`、`order_info`。用于生成类名和 DESCRIBE 表结构。 |
+| `force` | `boolean` | `false` | 是否强制覆盖已存在的文件。为 `false` 时遇到同名文件会跳过并提示。 |
+| `dryRun` | `boolean` | `false` | 模拟运行模式。只打印将要生成的文件列表，不实际写入磁盘。适合预览效果。 |
+| `compile` | `boolean` | `false` | 生成完成后是否自动执行 `mwtsc --cleanOutDir` 进行 TypeScript 编译。 |
+| `onlyEntity` | `boolean` | `false` | 仅生成 entity 实体文件，不生成 DTO、VO、Service、Controller 等其他文件。适合只需要实体类的场景。 |
+| `noDb` | `boolean` | `false` | 不连接数据库读取表结构。启用后使用内置模板字段生成（字段为示例占位，需手动修改）。 |
+| `templatesPath` | `string` | 无 | 自定义模板目录路径。在此目录下放置与默认模板同名的 `.njk` 文件即可覆盖对应模板。未覆盖的模板继续使用默认模板。 |
+| `db.host` | `string` | `127.0.0.1` | 数据库主机地址。 |
+| `db.port` | `number` | `3306` | 数据库端口。 |
+| `db.user` | `string` | `root` | 数据库用户名。 |
+| `db.password` | `string` | 空 | 数据库密码。 |
+| `db.database` | `string` | 交互式询问 | 数据库名。指定后会尝试连接数据库并 DESCRIBE 表结构，使用真实字段信息生成代码。 |
+| `db.type` | `string` | `mysql` | 数据库类型，目前仅支持 MySQL。 |
+
+> **优先级说明**：命令行参数 > 配置文件 > 默认值。例如命令行传了 `--force`，即使配置文件中 `force: false`，最终也会以 `true` 为准。
+
 ## 自定义模板
 
 本工具使用 [nunjucks](https://mozilla.github.io/nunjucks/) 作为模板引擎。所有模板文件均可自定义。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shys/crud",
-  "version": "1.0.1-beta.1",
+  "version": "1.0.1-beta.2",
   "description": "MidwayJS v4 模块化 CRUD CLI 生成器",
   "license": "MIT",
   "author": {

package/templates/entity.njk

@@ -6,7 +6,7 @@ import { Entity, Column{% if hasPk %}, PrimaryGeneratedColumn{% endif %}{% if id
 import { Expose{% if hasDateField %}, Transform{% endif %} } from 'class-transformer';
 import { ApiProperty, ApiPropertyOptional } from '@midwayjs/swagger';
 import { Rule } from '@midwayjs/validation';
-import { z } from 'zod';
+import * as Joi from 'joi';
 import { BaseEntity } from '../../../framework/entity/base.entity';
 
 @Entity({{ tableName | json }}, {
@@ -24,7 +24,7 @@ export class {{ Pascal }} extends BaseEntity {
     description: {{ (pkInfo.comment or '主键ID') | json }},
   })
   @Expose()
-  @Rule(z.number().int().describe({{ (pkInfo.comment or '主键ID') | json }}))
+  @Rule(Joi.number().integer().required())
   {{ pkInfo.camel }}: number;
 
 {% endif -%}
@@ -46,7 +46,7 @@ export class {{ Pascal }} extends BaseEntity {
 {% if f.defaultVal != null %}    example: {{ f.defaultVal | json }},
 {% endif %}  })
   @Expose()
-  @Rule({{ f.zodRule }}.nullable().optional())
+  @Rule({{ f.joiRule }})
 {% if f.isDate %}  @Transform(({ value }) => {
     if (value == null) return null;
     const d = value instanceof Date ? value : new Date(value);