@shys/crud 1.0.1-beta.4 → 1.0.1-beta.6

package/README.md

@@ -143,6 +143,8 @@ export default {
   onlyEntity: false,
   noDb: false,
   templatesPath: './my-templates',
+  baseFieldNames: ['createTime', 'updateTime', 'deleteTime'],
+  excludeWritableFields: ['ctime', 'mtime', 'created_at', 'updated_at', 'create_time', 'update_time'],
   db: {
     host: '127.0.0.1',
     port: 3306,
@@ -165,6 +167,8 @@ export default {
 | `dryRun` | `boolean` | `false` | 模拟运行模式。只打印将要生成的文件列表，不实际写入磁盘。适合预览效果。 |
 | `compile` | `boolean` | `false` | 生成完成后是否自动执行 `mwtsc --cleanOutDir` 进行 TypeScript 编译。 |
 | `onlyEntity` | `boolean` | `false` | 仅生成 entity 实体文件，不生成 DTO、VO、Service、Controller 等其他文件。适合只需要实体类的场景。 |
+| `baseFieldNames` | `string[]` | `["createTime","updateTime","deleteTime"]` | BaseEntity 基础字段列表（驼峰命名）。这些字段会从 Entity 模板中排除（不重复声明）。如果你的基类使用了不同的字段名，可以在此配置。 |
+| `excludeWritableFields` | `string[]` | `["ctime","mtime","created_at","updated_at","create_time","update_time"]` | 自动写入的时间戳字段列表（数据库原始字段名）。这些字段不会出现在 Create/Update/Replace DTO 中，因为它们通常由数据库或框架自动维护。 |
 | `noDb` | `boolean` | `false` | 不连接数据库读取表结构。启用后使用内置模板字段生成（字段为示例占位，需手动修改）。 |
 | `templatesPath` | `string` | 无 | 自定义模板目录路径。在此目录下放置与默认模板同名的 `.njk` 文件即可覆盖对应模板。未覆盖的模板继续使用默认模板。 |
 | `db.host` | `string` | `127.0.0.1` | 数据库主机地址。 |
@@ -207,76 +211,162 @@ export default {
 
 ### 模板变量参考
 
+所有模板共享以下通用命名变量：
+
+| 变量 | 类型 | 说明 | 示例 |
+|------|------|------|------|
+| `tableName` | `string` | 数据库表名 | `"sys_user"` |
+| `Camel` | `string` | 表名的 camelCase 形式 | `"sysUser"` |
+| `Pascal` | `string` | 表名的 PascalCase 形式 | `"SysUser"` |
+| `CreateName` | `string` | Create DTO 类名 | `"CreateSysUserDto"` |
+| `UpdateName` | `string` | Update DTO 类名 | `"UpdateSysUserDto"` |
+| `ReplaceName` | `string` | Replace DTO 类名 | `"ReplaceSysUserDto"` |
+| `QueryName` | `string` | Query DTO 类名 | `"QuerySysUserDto"` |
+| `VOName` | `string` | 单个 VO 类名 | `"SysUserVO"` |
+| `ListVOName` | `string` | 列表 VO 类名 | `"SysUserListVO"` |
+| `ServiceName` | `string` | Service 类名 | `"SysUserService"` |
+| `CtrlName` | `string` | Controller 类名 | `"SysUserController"` |
+| `pluralKebab` | `string` | 复数 kebab-case 路由名 | `"sys-users"` |
+| `tagName` | `string` | Swagger tag 名 | `"SysUser管理"` |
+| `desc` | `string` | 接口描述 | `"sys_user 表增删改查接口"` |
+
+#### 字段对象（Field）属性
+
+所有字段列表（如 `fields`、`createFields`、`writable`、`filterable`）中的每个字段对象都包含以下属性：
+
+| 属性 | 类型 | 说明 | 示例 |
+|------|------|------|------|
+| `name` | `string` | 数据库字段名 | `"user_name"` |
+| `camel` | `string` | 驼峰命名 | `"userName"` |
+| `type` | `string` | 数据库原始类型 | `"varchar"` |
+| `ormType` | `string` | ORM 类型（标准化后） | `"varchar"` |
+| `jsType` | `string` | JavaScript 类型（含 null） | `"string \| null"` |
+| `createDtoType` | `string` | Create DTO 中的类型 | `"string \| null"` |
+| `voType` | `string` | VO 中的类型（日期转 string） | `"string"` |
+| `swagType` | `string` | Swagger 类型字符串 | `"'string'"` |
+| `len` | `number \| null` | 字段长度 | `64` |
+| `nullable` | `boolean` | 是否可空 | `true` |
+| `comment` | `string` | 字段注释 | `"用户名"` |
+| `defaultVal` | `any` | 默认值 | `""` |
+| `pk` | `boolean` | 是否主键 | `false` |
+| `auto` | `boolean` | 是否自增 | `false` |
+| `joiRule` | `string` | Joi 验证规则（非必填） | `"Joi.string().max(64).label('用户名').allow(null)"` |
+| `joiRuleRequired` | `string` | Joi 验证规则（必填） | `"Joi.string().max(64).label('用户名').required()"` |
+| `supportsLength` | `boolean` | 该类型是否支持长度 | `true` |
+| `isDate` | `boolean` | 是否日期类型 | `false` |
+| `isSensitive` | `boolean` | 是否敏感字段（密码等） | `false` |
+| `idx` | `boolean` | 是否索引字段（仅 entity 模板） | `false` |
+
+---
+
 #### entity.njk
 
-```
-orm: string              // ORM 类型：typeorm/sequelize/mikro-orm
-ormSuffix: string        // 实体文件后缀：entity/model
-fields: Array<{          // 字段列表（排除主键和基础字段）
-  name: string           // 数据库字段名
-  camel: string          // 驼峰命名
-  type: string           // 数据库类型
-  jsType: string         // JavaScript 类型
-  ormType: string        // ORM 类型
-  len: number | null     // 字段长度
-  nullable: boolean      // 是否可空
-  comment: string        // 字段注释
-  supportsLength: boolean
-  isDate: boolean
-  isSensitive: boolean
-  idx: boolean           // 是否索引字段
-}>
-tableName: string        // 表名
-Pascal: string           // PascalCase 命名
-Camel: string            // camelCase 命名
-pkInfo: Object | null    // 主键信息
-hasPk: boolean           // 是否有主键
-hasDateField: boolean    // 是否有日期字段
-idxCount: number         // 索引字段数量
-```
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `orm` | `string` | ORM 类型：`typeorm` / `sequelize` / `mikro` / `mongoose` |
+| `ormSuffix` | `string` | 实体文件后缀：`entity` / `model` |
+| `fields` | `Field[]` | 字段列表（排除主键和 BaseEntity 基础字段） |
+| `tableName` | `string` | 表名 |
+| `Pascal` | `string` | PascalCase 命名 |
+| `Camel` | `string` | camelCase 命名 |
+| `pkInfo` | `Field \| null` | 主键字段信息（已增强） |
+| `hasPk` | `boolean` | 是否有主键 |
+| `hasDateField` | `boolean` | 是否包含日期字段 |
+| `idxCount` | `number` | 索引字段数量 |
+
+#### dto-create.njk
+
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `CreateName` | `string` | Create DTO 类名 |
+| `Pascal` | `string` | PascalCase 命名 |
+| `Camel` | `string` | camelCase 命名 |
+| `createFields` | `Field[]` | 可创建字段列表（排除自增主键） |
+| `picks` | `string` | Pick 字段列表字符串，如 `"name",\n  "email"` |
 
-#### dto-create.njk / dto-update.njk / dto-replace.njk
+#### dto-update.njk
 
-```
-CreateName: string       // Create DTO 类名
-UpdateName: string       // Update DTO 类名
-ReplaceName: string      // Replace DTO 类名
-Pascal: string           // PascalCase 命名
-createFields: Array      // 可创建字段
-writable: Array          // 可写字段
-picks: string            // Pick 类型的字段列表字符串
-typeArgs: string         // 类型联合字符串
-```
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `UpdateName` | `string` | Update DTO 类名 |
+| `CreateName` | `string` | Create DTO 类名（用于继承） |
+| `writable` | `Field[]` | 可写字段列表（排除时间戳字段） |
+| `picks` | `string` | Pick 字段列表字符串 |
+| `typeArgs` | `string` | 类型联合字符串，如 `'name' \| 'email'` |
+
+#### dto-replace.njk
+
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `ReplaceName` | `string` | Replace DTO 类名 |
+| `CreateName` | `string` | Create DTO 类名（用于继承） |
+| `writable` | `Field[]` | 可写字段列表 |
+| `picks` | `string` | Pick 字段列表字符串 |
+
+#### dto-query.njk
+
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `QueryName` | `string` | Query DTO 类名 |
+| `filterable` | `Field[]` | 可筛选字段列表（含主键） |
+| `picks` | `string` | Pick 字段列表字符串 |
+| `typeArgs` | `string` | 类型联合字符串 |
+| `sortDescription` | `string` | sort 字段的描述文本 |
+| `filterExample` | `string` | filter 字段的示例值 |
+| `searchDescription` | `string` | search 字段的描述文本 |
+
+#### vo-single.njk
+
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `VOName` | `string` | 单个 VO 类名 |
+| `Pascal` | `string` | PascalCase 命名（Entity 类名，用于继承） |
+| `Camel` | `string` | camelCase 命名 |
+| `fields` | `Field[]` | 所有字段（含主键，排除 BaseEntity 基础字段） |
+| `hasTransform` | `boolean` | 是否有需要转换的字段（日期/敏感） |
+
+#### vo-list.njk
+
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `ListVOName` | `string` | 列表 VO 类名 |
+| `VOName` | `string` | 单个 VO 类名 |
+| `Camel` | `string` | camelCase 命名 |
+
+#### vo-index.njk
+
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `Camel` | `string` | camelCase 命名 |
 
 #### service.njk
 
-```
-ServiceName: string      // Service 类名
-Pascal: string           // PascalCase 命名
-Camel: string            // camelCase 命名
-ormInfo: {
-  orm: string
-  ormSuffix: string
-  serviceParent: string  // 父类名
-  importCrudOrm: string  // 导入语句
-  injectEntity: string   // 装饰器名
-}
-```
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `ServiceName` | `string` | Service 类名 |
+| `Pascal` | `string` | PascalCase 命名 |
+| `Camel` | `string` | camelCase 命名 |
+| `ormInfo` | `object` | ORM 信息对象 |
 
 #### controller.njk
 
-```
-CtrlName: string         // Controller 类名
-ServiceName: string      // Service 类名
-Pascal: string
-Camel: string
-pluralKebab: string      // 复数 kebab-case 路由名
-tagName: string          // Swagger tag 名
-desc: string             // 接口描述
-sortable: string[]       // 可排序字段
-filterable: string[]     // 可过滤字段
-searchable: string[]     // 可搜索字段
-```
+| 变量 | 类型 | 说明 |
+|------|------|------|
+| `CtrlName` | `string` | Controller 类名 |
+| `Pascal` | `string` | PascalCase 命名 |
+| `ServiceName` | `string` | Service 类名 |
+| `CreateName` / `UpdateName` / `ReplaceName` / `QueryName` | `string` | 各 DTO 类名 |
+| `VOName` / `ListVOName` | `string` | 各 VO 类名 |
+| `Camel` | `string` | camelCase 命名 |
+| `pluralKebab` | `string` | 复数 kebab-case 路由名 |
+| `tagName` | `string` | Swagger tag 名 |
+| `desc` | `string` | 接口描述 |
+| `sortable` | `string` | 可排序字段 JSON 字符串 |
+| `filterable` | `string` | 可过滤字段 JSON 字符串 |
+| `searchable` | `string` | 可搜索字段 JSON 字符串 |
+| `pkCamel` | `string` | 主键驼峰名 |
+| `idField` | `string` | ID 字段名 |
+| `defaultSort` | `string` | 默认排序配置 JSON 字符串 |
 
 ### 自定义模板示例
 

package/dist/cli.js

@@ -277,6 +277,8 @@ export async function runCli(argv = process.argv.slice(2)) {
         outputPath,
         templatesPath,
         onlyEntity: cli.onlyEntity,
+        baseFieldNames: cli.baseFieldNames,
+        excludeWritableFields: cli.excludeWritableFields,
     });
     console.log(`\n${chalk.cyan(`生成清单（${built.files.length}）`)}`);
     const stats = writeAll(built.files, { force: !!cli.force, dryRun: !!cli.dryRun });

package/dist/config.js

@@ -107,6 +107,10 @@ export function mergeConfigs(...configs) {
             result.templatesPath = config.templatesPath;
         if (config.onlyEntity !== undefined)
             result.onlyEntity = config.onlyEntity;
+        if (config.baseFieldNames !== undefined)
+            result.baseFieldNames = config.baseFieldNames;
+        if (config.excludeWritableFields !== undefined)
+            result.excludeWritableFields = config.excludeWritableFields;
         if (config.db) {
             result.db = { ...(result.db || {}), ...config.db };
         }

package/dist/db.js

@@ -52,7 +52,7 @@ export async function getTableFieldsFromDb(dbConfig, tableName) {
             database: database || '',
         });
         try {
-            const [rows] = await connection.execute(`SELECT column_name, data_type, is_nullable, column_type, column_comment, column_default, character_maximum_length, extra 
+            const [rows] = await connection.execute(`SELECT column_name, data_type, is_nullable, column_type, column_comment, column_default, character_maximum_length, extra, column_key 
          FROM information_schema.COLUMNS 
          WHERE table_schema = ? AND table_name = ? 
          ORDER BY ordinal_position`, [database, tableName]);
@@ -68,7 +68,8 @@ export async function getTableFieldsFromDb(dbConfig, tableName) {
                 const defaultVal = row.COLUMN_DEFAULT || row.column_default;
                 const length = row.CHARACTER_MAXIMUM_LENGTH || row.character_maximum_length;
                 const extra = row.EXTRA || row.extra || '';
-                const isPk = extra.includes('PRI') || columnName.toLowerCase().includes('id');
+                const columnKey = row.COLUMN_KEY || row.column_key || '';
+                const isPk = columnKey === 'PRI';
                 const isAuto = extra.includes('auto_increment');
                 return {
                     name: columnName,

package/dist/generator.d.ts

@@ -23,5 +23,7 @@ export interface BuildFilesParams {
     templatesPath?: string;
     renderer?: TemplateRenderer;
     onlyEntity?: boolean;
+    baseFieldNames?: string[];
+    excludeWritableFields?: string[];
 }
 export declare function buildFiles(params: BuildFilesParams): BuildResult;

package/dist/generator.js

@@ -1,19 +1,54 @@
 import { resolve } from 'node:path';
 import { toCamelCase, toPascalCase, toPluralKebab } from './utils.js';
 import { createRenderer } from './renderer.js';
-const BASE_FIELD_NAMES = ['createTime', 'updateTime', 'deleteTime'];
+const DEFAULT_BASE_FIELD_NAMES = ['createTime', 'updateTime', 'deleteTime'];
+const DEFAULT_EXCLUDE_WRITABLE_FIELDS = [
+    'ctime',
+    'mtime',
+    'created_at',
+    'updated_at',
+    'create_time',
+    'update_time',
+];
 const JSTypeMap = {
-    int: 'number', integer: 'number', bigint: 'number', smallint: 'number', tinyint: 'number', mediumint: 'number',
-    decimal: 'number', numeric: 'number', float: 'number', double: 'number', real: 'number',
-    char: 'string', varchar: 'string', text: 'string', tinytext: 'string', mediumtext: 'string', longtext: 'string',
-    enum: 'string', set: 'string', json: 'any',
-    date: 'Date', datetime: 'Date', timestamp: 'Date', time: 'Date', year: 'number',
-    binary: 'Buffer', varbinary: 'Buffer', blob: 'Buffer',
-    bool: 'boolean', boolean: 'boolean', bit: 'boolean',
+    int: 'number',
+    integer: 'number',
+    bigint: 'number',
+    smallint: 'number',
+    tinyint: 'number',
+    mediumint: 'number',
+    decimal: 'number',
+    numeric: 'number',
+    float: 'number',
+    double: 'number',
+    real: 'number',
+    char: 'string',
+    varchar: 'string',
+    text: 'string',
+    tinytext: 'string',
+    mediumtext: 'string',
+    longtext: 'string',
+    enum: 'string',
+    set: 'string',
+    json: 'any',
+    date: 'Date',
+    datetime: 'Date',
+    timestamp: 'Date',
+    time: 'Date',
+    year: 'number',
+    binary: 'Buffer',
+    varbinary: 'Buffer',
+    blob: 'Buffer',
+    bool: 'boolean',
+    boolean: 'boolean',
+    bit: 'boolean',
 };
 const NO_LENGTH_ORM_TYPES = /^(text|tinytext|mediumtext|longtext|blob|tinyblob|mediumblob|longblob|json)$/i;
 function normalizeOrmType(type) {
-    return String(type).toLowerCase().replace(/\(\d+.*?\)/, '').trim() || 'varchar';
+    return (String(type)
+        .toLowerCase()
+        .replace(/\(\d+.*?\)/, '')
+        .trim() || 'varchar');
 }
 function fieldSupportsLength(f) {
     return !NO_LENGTH_ORM_TYPES.test(normalizeOrmType(f.type));
@@ -30,9 +65,19 @@ function createDtoTypeOf(field) {
 }
 function joiSwagType(f) {
     const t = f.type;
-    if (t === 'int' || t === 'bigint' || t === 'smallint' || t === 'tinyint' || t === 'mediumint' || t === 'integer')
+    if (t === 'int' ||
+        t === 'bigint' ||
+        t === 'smallint' ||
+        t === 'tinyint' ||
+        t === 'mediumint' ||
+        t === 'integer')
         return `'integer'`;
-    if (t === 'decimal' || t === 'numeric' || t === 'float' || t === 'double' || t === 'real' || t === 'number')
+    if (t === 'decimal' ||
+        t === 'numeric' ||
+        t === 'float' ||
+        t === 'double' ||
+        t === 'real' ||
+        t === 'number')
         return `'number'`;
     if (t === 'datetime' || t === 'timestamp' || t === 'date')
         return `'string'`;
@@ -114,13 +159,18 @@ function enhanceField(f, extra = {}) {
         supportsLength: fieldSupportsLength(f),
         isDate: /datetime|date|timestamp/i.test(f.type),
         isSensitive: /password|passwd|salt|token|secret|private_key/i.test(f.name + f.camel),
-        voType: /datetime|date|timestamp/i.test(f.type) ? 'string' : (JSTypeMap[f.type] || 'string'),
+        voType: /datetime|date|timestamp/i.test(f.type)
+            ? 'string'
+            : JSTypeMap[f.type] || 'string',
         idx: !!extra.idx,
     };
 }
 export function buildFiles(params) {
-    const { moduleName, tableName, baseSrcPath, ormInfo, fields, outputPath, templatesPath, renderer: customRenderer, onlyEntity } = params;
+    const { moduleName, tableName, baseSrcPath, ormInfo, fields, outputPath, templatesPath, renderer: customRenderer, onlyEntity, baseFieldNames, excludeWritableFields, } = params;
     const renderer = customRenderer || createRenderer({ customTemplatesPath: templatesPath });
+    const finalBaseFieldNames = baseFieldNames ?? DEFAULT_BASE_FIELD_NAMES;
+    const finalExcludeWritable = excludeWritableFields ?? DEFAULT_EXCLUDE_WRITABLE_FIELDS;
+    const excludeWritableRegex = new RegExp(finalExcludeWritable.map(s => `^${s}$`).join('|'), 'i');
     const Camel = toCamelCase(tableName);
     const Pascal = toPascalCase(tableName);
     const CreateName = `Create${Pascal}Dto`;
@@ -136,18 +186,19 @@ export function buildFiles(params) {
     const desc = `${tableName} 表增删改查接口`;
     const modRoot = resolve(outputPath || baseSrcPath, 'modules', moduleName);
     const resultFiles = [];
-    const originalPkInfo = fields.find((f) => f.pk);
+    const originalPkInfo = fields.find(f => f.pk);
     const hasPk = !!originalPkInfo;
-    const entityFields = fields.filter((f) => {
-        if (BASE_FIELD_NAMES.includes(f.camel))
+    const entityFields = fields.filter(f => {
+        if (finalBaseFieldNames.includes(f.camel))
             return false;
         if (f.pk)
             return false;
         return true;
     });
-    const idxFields = entityFields.filter((f) => !f.pk && (String(f.name).toUpperCase() === 'COUNTRYCODE' || /_id$/.test(f.name)));
-    const hasDateField = entityFields.some((f) => /datetime|date|timestamp/i.test(f.type));
-    const enhancedEntityFields = entityFields.map((f) => enhanceField(f, { idx: idxFields.some((i) => i.name === f.name) }));
+    const idxFields = entityFields.filter(f => !f.pk &&
+        (String(f.name).toUpperCase() === 'COUNTRYCODE' || /_id$/.test(f.name)));
+    const hasDateField = entityFields.some(f => /datetime|date|timestamp/i.test(f.type));
+    const enhancedEntityFields = entityFields.map(f => enhanceField(f, { idx: idxFields.some(i => i.name === f.name) }));
     const enhancedPkInfo = originalPkInfo ? enhanceField(originalPkInfo) : null;
     // Entity
     resultFiles.push({
@@ -176,37 +227,46 @@ export function buildFiles(params) {
             searchable: [],
         };
     }
-    const createFields = entityFields.filter((f) => !(f.pk && f.auto));
-    const writable = createFields.filter((f) => !/ctime|mtime|created_at|updated_at|create_time|update_time/i.test(f.name));
+    const createFields = entityFields.filter(f => !(f.pk && f.auto));
+    const writable = createFields.filter(f => !excludeWritableRegex.test(f.name));
     const isSensitive = (f) => /password|passwd|salt|token|secret|private_key/i.test(f.name + f.camel);
     const pkCamel = originalPkInfo?.camel || '';
-    const sortableBase = entityFields.filter((f) => !isSensitive(f)).map((f) => f.camel);
+    const sortableBase = entityFields
+        .filter(f => !isSensitive(f))
+        .map(f => f.camel);
     const sortable = pkCamel && !sortableBase.includes(pkCamel)
         ? [pkCamel, ...sortableBase]
         : sortableBase;
-    const filterableBase = entityFields.filter((f) => !isSensitive(f));
-    const filterableArr = pkCamel && !filterableBase.some((f) => f.camel === pkCamel)
+    const filterableBase = entityFields.filter(f => !isSensitive(f));
+    const filterableArr = pkCamel && !filterableBase.some(f => f.camel === pkCamel)
         ? [originalPkInfo, ...filterableBase]
         : filterableBase;
-    const filterable = filterableArr.map((f) => f.camel);
+    const filterable = filterableArr.map(f => f.camel);
     const searchable = filterableArr
-        .filter((f) => /char|varchar|text/i.test(f.type))
-        .map((f) => f.camel);
-    const enhancedCreateFields = createFields.map((f) => enhanceField(f));
-    const enhancedWritable = writable.map((f) => enhanceField(f));
-    const enhancedFilterable = filterableArr.map((f) => enhanceField(f));
+        .filter(f => /char|varchar|text/i.test(f.type))
+        .map(f => f.camel);
+    const enhancedCreateFields = createFields.map(f => enhanceField(f));
+    const enhancedWritable = writable.map(f => enhanceField(f));
+    const enhancedFilterable = filterableArr.map(f => enhanceField(f));
     // Create DTO
+    const createPicks = enhancedCreateFields
+        .map(f => JSON.stringify(f.camel))
+        .join(',\n  ');
     resultFiles.push({
         path: resolve(modRoot, `dto/${Camel}/create.dto.ts`),
         content: renderer.render('dto-create', {
             CreateName,
             Pascal,
+            Camel,
             createFields: enhancedCreateFields,
+            picks: createPicks,
         }),
     });
     // Update DTO
-    const updatePicks = enhancedWritable.map((f) => JSON.stringify(f.camel)).join(',\n  ');
-    const updateTypeArgs = enhancedWritable.map((f) => `'${f.camel}'`).join(' | ');
+    const updatePicks = enhancedWritable
+        .map(f => JSON.stringify(f.camel))
+        .join(',\n  ');
+    const updateTypeArgs = enhancedWritable.map(f => `'${f.camel}'`).join(' | ');
     resultFiles.push({
         path: resolve(modRoot, `dto/${Camel}/update.dto.ts`),
         content: renderer.render('dto-update', {
@@ -218,7 +278,9 @@ export function buildFiles(params) {
         }),
     });
     // Replace DTO
-    const replacePicks = enhancedWritable.map((f) => JSON.stringify(f.camel)).join(',\n  ');
+    const replacePicks = enhancedWritable
+        .map(f => JSON.stringify(f.camel))
+        .join(',\n  ');
     resultFiles.push({
         path: resolve(modRoot, `dto/${Camel}/replace.dto.ts`),
         content: renderer.render('dto-replace', {
@@ -229,12 +291,14 @@ export function buildFiles(params) {
         }),
     });
     // Query DTO
-    const queryPicks = enhancedFilterable.map((f) => JSON.stringify(f.camel)).join(',\n  ');
-    const queryTypeArgs = enhancedFilterable.map((f) => `'${f.camel}'`).join(' | ');
+    const queryPicks = enhancedFilterable
+        .map(f => JSON.stringify(f.camel))
+        .join(',\n  ');
+    const queryTypeArgs = enhancedFilterable.map(f => `'${f.camel}'`).join(' | ');
     const sortEx = filterable[0] ? `${filterable[0]}:ASC,id:DESC` : 'id:DESC';
     const filterEx = filterableArr
         .slice(0, 2)
-        .map((f) => {
+        .map(f => {
         const isStr = /char|varchar|text/i.test(f.type);
         return isStr ? `${f.camel}:like:a` : `${f.camel}:gte:10`;
     })
@@ -248,7 +312,8 @@ export function buildFiles(params) {
             filterable: enhancedFilterable,
             picks: queryPicks,
             typeArgs: queryTypeArgs || 'never',
-            sortDescription: '排序字段。标准格式：field:ASC 或 field:DESC；多字段用英文逗号分隔，或多次传 sort。示例：id:DESC、' + sortEx,
+            sortDescription: '排序字段。标准格式：field:ASC 或 field:DESC；多字段用英文逗号分隔，或多次传 sort。示例：id:DESC、' +
+                sortEx,
             filterExample: filterEx || 'id:gte:1',
             searchDescription: '搜索关键字，对可搜索字段（' + searchFields + '）模糊匹配',
         }),
@@ -259,12 +324,17 @@ export function buildFiles(params) {
         content: renderer.render('dto-index', {}),
     });
     // Single VO
-    const allVoFields = [...(originalPkInfo ? [originalPkInfo] : []), ...entityFields].map((f) => enhanceField(f));
-    const voHasTransform = allVoFields.some((f) => f.isDate || f.isSensitive);
+    const allVoFields = [
+        ...(originalPkInfo ? [originalPkInfo] : []),
+        ...entityFields,
+    ].map(f => enhanceField(f));
+    const voHasTransform = allVoFields.some(f => f.isDate || f.isSensitive);
     resultFiles.push({
         path: resolve(modRoot, `vo/${Camel}/${Camel}.vo.ts`),
         content: renderer.render('vo-single', {
             VOName,
+            Pascal,
+            Camel,
             fields: allVoFields,
             hasTransform: voHasTransform,
         }),
@@ -294,7 +364,7 @@ export function buildFiles(params) {
         }),
     });
     // Controller
-    const sArr = (arr) => arr.map((x) => JSON.stringify(x)).join(', ');
+    const sArr = (arr) => arr.map(x => JSON.stringify(x)).join(', ');
     const idField = pkCamel || 'id';
     const defaultSort = searchable && searchable.length
         ? `[{ field: ${JSON.stringify(sortable[0] || idField)}, order: 'DESC' }]`
@@ -302,10 +372,19 @@ export function buildFiles(params) {
     resultFiles.push({
         path: resolve(modRoot, `controller/${Camel}.controller.ts`),
         content: renderer.render('controller', {
-            CtrlName, Pascal, ServiceName,
-            CreateName, UpdateName, ReplaceName, QueryName,
-            VOName, ListVOName,
-            Camel, pluralKebab, tagName, desc,
+            CtrlName,
+            Pascal,
+            ServiceName,
+            CreateName,
+            UpdateName,
+            ReplaceName,
+            QueryName,
+            VOName,
+            ListVOName,
+            Camel,
+            pluralKebab,
+            tagName,
+            desc,
             sortable: sArr(sortable),
             filterable: sArr(filterable),
             searchable: sArr(searchable),
@@ -321,5 +400,13 @@ export function buildFiles(params) {
         content: renderer.render('crud-page-vo', {}),
         createOnly: true,
     });
-    return { files: resultFiles, Pascal, pluralKebab, Camel, sortable, filterable, searchable };
+    return {
+        files: resultFiles,
+        Pascal,
+        pluralKebab,
+        Camel,
+        sortable,
+        filterable,
+        searchable,
+    };
 }

package/dist/types.d.ts

@@ -18,6 +18,8 @@ export interface CrudConfig {
     outputPath?: string;
     templatesPath?: string;
     onlyEntity?: boolean;
+    baseFieldNames?: string[];
+    excludeWritableFields?: string[];
 }
 export interface CliOptions extends CrudConfig {
     help?: boolean;

package/package.json

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

package/templates/dto-create.njk

@@ -1,18 +1,6 @@
-import { Rule } from '@midwayjs/validation';
-import { ApiPropertyOptional } from '@midwayjs/swagger';
-import * as Joi from 'joi';
+import { PickDto } from '@midwayjs/validation';
+import { {{ Pascal }} } from '../../entity/{{ Camel }}.entity';
 
-export class {{ CreateName }} {
-{% for f in createFields -%}
-  @ApiPropertyOptional({
-    type: {{ f.swagType | json }},
-{% if f.len %}    maxLength: {{ f.len }},
-{% endif %}{% if f.nullable %}    nullable: true,
-{% endif %}    description: {{ (f.comment or f.camel) | json }},
-{% if f.defaultVal != null %}    example: {{ f.defaultVal | json }},
-{% endif %}  })
-  @Rule({{ f.joiRule }}.description({{ (f.comment or f.camel) | json }}))
-  {{ f.camel }}?: {{ f.createDtoType }};
-
-{% endfor -%}
-}
+export class {{ CreateName }} extends PickDto({{ Pascal }}, [
+  {{ picks }}
+]) {}

package/templates/dto-query.njk

@@ -1,71 +1,17 @@
-import { Rule, PickDto } from '@midwayjs/validation';
 import { ApiPropertyOptional } from '@midwayjs/swagger';
+import { Rule } from '@midwayjs/validation';
 import * as Joi from 'joi';
-import { {{ CreateName }} } from './create.dto';
+import { CrudBaseQueryDto } from '../../../../framework/dto/base.query.dto';
 
-type _QueryFilterFields = Pick<{{ CreateName }}, {{ typeArgs }}>;
-
-const _QueryFilterPicked = PickDto({{ CreateName }}, [
-  {{ picks }}
-]) as unknown as new () => Partial<_QueryFilterFields>;
-
-export class {{ QueryName }} extends _QueryFilterPicked {
+export class {{ QueryName }} extends CrudBaseQueryDto {
 {% for f in filterable -%}
   @ApiPropertyOptional({
     type: {{ f.swagType | json }},
 {% if f.len %}    maxLength: {{ f.len }},
-{% endif %}    description: {{ ((f.comment or f.camel) + '（列表筛选条件，可选）') | json }},
+{% endif %}    description: {{ (f.comment or f.camel) | json }},
   })
-  override {{ f.camel }}?: {{ f.jsType }};
+  @Rule({{ f.joiRule }}.optional())
+  {{ f.camel }}?: {{ f.jsType }};
 
 {% endfor -%}
-{% if filterable.length %}
-
-{% endif %}  @ApiPropertyOptional({
-    type: 'integer',
-    minimum: 1,
-    default: 1,
-    description: '当前页码，从1开始',
-    example: 1,
-  })
-  @Rule(Joi.number().integer().min(1).default(1).description('当前页码，从1开始，默认1'))
-  page?: number;
-
-  @ApiPropertyOptional({
-    type: 'integer',
-    minimum: 1,
-    maximum: 100,
-    default: 10,
-    description: '每页条数，范围 1-100',
-    example: 10,
-  })
-  @Rule(Joi.number().integer().min(1).max(100).default(10).description('每页条数，1-100，默认10'))
-  limit?: number;
-
-  @ApiPropertyOptional({
-    type: 'string',
-    description: {{ sortDescription | json }},
-    example: 'id:DESC',
-  })
-  @Rule(Joi.string().description('排序字段，例如 id:ASC 或 name:DESC,id:DESC'))
-  sort?: string;
-
-  @ApiPropertyOptional({
-    type: 'string',
-    description:
-      '过滤条件（兼容两种写法）。官方标准：field||op||value，多条件多次传或逗号分隔。简写：field:op:value 逗号分隔。' +
-      '操作符 eq/ne/gt/gte/lt/lte/in/like，别名 ==/!=/>/>=/</<=/contains。' +
-      '示例：age||gte||18,name||like||张 或 age:gte:18,name:like:张',
-    example: {{ filterExample | json }},
-  })
-  @Rule(Joi.string().description('过滤条件，支持 field||op||value 或 field:op:value，逗号分隔多条件'))
-  filter?: string;
-
-  @ApiPropertyOptional({
-    type: 'string',
-    description: {{ searchDescription | json }},
-    example: 'zhang',
-  })
-  @Rule(Joi.string().description('搜索关键字，用于模糊搜索可搜索字段'))
-  search?: string;
 }

package/templates/dto-replace.njk

@@ -14,7 +14,7 @@ export class {{ ReplaceName }} extends PickDto({{ CreateName }}, [
 {% endif %}    required: true,
     description: {{ ((f.comment or f.camel) + '（PUT：必须完整传入）') | json }},
   })
-  @Rule({{ f.joiRuleRequired }}.description({{ (f.comment or f.camel) | json }}))
+  @Rule({{ f.joiRuleRequired }})
   override {{ f.camel }}: {{ f.createDtoType }};
 
 {% endfor -%}

package/templates/dto-update.njk

@@ -2,21 +2,8 @@ import { ApiPropertyOptional } from '@midwayjs/swagger';
 import { PickDto } from '@midwayjs/validation';
 import { {{ CreateName }} } from './create.dto';
 
-type _UpdateFields = Pick<{{ CreateName }}, {{ typeArgs }}>;
-
-const _UpdatePicked = PickDto({{ CreateName }}, [
+export class {{ UpdateName }} extends PickDto({{ CreateName }}, [
   {{ picks }}
-]) as unknown as new () => Partial<_UpdateFields>;
-
-export class {{ UpdateName }} extends _UpdatePicked {
-{% for f in writable -%}
-  @ApiPropertyOptional({
-    type: {{ f.swagType | json }},
-{% if f.len %}    maxLength: {{ f.len }},
-{% endif %}{% if f.nullable %}    nullable: true,
-{% endif %}    description: {{ ((f.comment or f.camel) + '（PATCH：不传则不修改）') | json }},
-  })
-  override {{ f.camel }}?: {{ f.createDtoType }};
+]) {
 
-{% endfor -%}
 }

package/templates/vo-single.njk

@@ -1,24 +1,3 @@
-import { Exclude, Expose{% if hasTransform %}, Transform{% endif %} } from 'class-transformer';
-import { ApiProperty } from '@midwayjs/swagger';
+import { {{ Pascal }} } from '../../entity/{{ Camel }}.entity';
 
-@Exclude()
-export class {{ VOName }} {
-{% for f in fields -%}
-  @ApiProperty({
-    type: {{ f.swagType | json }},
-{% if f.len %}    maxLength: {{ f.len }},
-{% endif %}{% if f.nullable %}    nullable: true,
-{% endif %}    description: {{ (f.comment or f.camel) | json }},
-  })
-  @Expose()
-{% if f.isDate %}  @Transform(({ value }) => {
-    if (value == null) return null;
-    const d = value instanceof Date ? value : new Date(value);
-    if (isNaN(d.getTime())) return value == null ? null : String(value);
-    return d.toISOString();
-  })
-{% endif %}{% if f.isSensitive %}  @Transform(() => undefined, { toPlainOnly: true })
-{% endif %}  {{ f.camel }}: {{ f.voType }}{% if f.nullable %} | null{% endif %};
-
-{% endfor -%}
-}
+export class {{ VOName }} extends {{ Pascal }} {}