@shys/crud 1.0.1-beta.7 → 1.0.1-beta.8

package/dist/cli.js

@@ -16,56 +16,56 @@ const warn = (t) => console.log(`${chalk.yellow('!')} ${t}`);
 const err = (t) => console.log(`${chalk.red('✘')} ${t}`);
 const info = (t) => console.log(`${chalk.cyan('ℹ')} ${t}`);
 function printHelp() {
-    console.log(`shys-crud CLI — MidwayJS v4 模块化 CRUD 代码生成器
-
-用法：
-  shys-crud --module <moduleName> --table <tableName> [选项]
-  npx @shys/crud --module <moduleName> --table <tableName> [选项]
-
-参数：
-  -m, --module    模块名（如 home/order/goods）
-  -t, --table     表名（如 sys_dept/city/order_info）
-  -s, --src       src 根路径（默认 ./src 或从配置文件读取）
-  -o, --output    生成文件输出路径（默认与 --src 相同）
-      --templates-path  自定义模板目录路径
-
-选项：
-  -f, --force     强制覆盖已存在的文件
-  -n, --dry-run   模拟运行，不实际写入文件
-  -c, --compile   生成完后自动执行 mwtsc --cleanOutDir
-      --only-entity  仅生成 entity 文件，不生成 DTO/VO/Service/Controller
-      --no-db     不尝试连库，使用模板字段模式
-      --db-host   数据库 host
-      --db-port   数据库端口（默认 3306）
-      --db-user   数据库用户名
-      --db-pass   数据库密码
-      --db-name   数据库名
-  -h, --help      显示帮助信息
-
-配置文件支持（按优先级从高到低）：
-  --src 指向的目录或 cwd 下查找：
-  - crud.config.ts / crud.config.js / crud.config.mjs / crud.config.cjs
-  - .crudrc / .crudrc.json / .crudrc.yaml / .crudrc.yml / .crudrc.js
-  - .config/crudrc / .config/crudrc.json
-  - package.json 中的 "crud" 字段
-
-配置文件示例（crud.config.ts）：
-  export default {
-    baseSrcPath: './src',
-    outputPath: './src',
-    db: {
-      host: '127.0.0.1',
-      port: 3306,
-      user: 'root',
-      password: '',
-      database: 'mydb',
-    },
-  }
-
-示例：
-  shys-crud --module home --table sys_dept
-  shys-crud --module order --table order_info --force
-  shys-crud -m home -t city -s ./packages/webtest/src --db-name world
+    console.log(`shys-crud CLI — MidwayJS v4 模块化 CRUD 代码生成器
+
+用法：
+  shys-crud --module <moduleName> --table <tableName> [选项]
+  npx @shys/crud --module <moduleName> --table <tableName> [选项]
+
+参数：
+  -m, --module    模块名（如 home/order/goods）
+  -t, --table     表名（如 sys_dept/city/order_info）
+  -s, --src       src 根路径（默认 ./src 或从配置文件读取）
+  -o, --output    生成文件输出路径（默认与 --src 相同）
+      --templates-path  自定义模板目录路径
+
+选项：
+  -f, --force     强制覆盖已存在的文件
+  -n, --dry-run   模拟运行，不实际写入文件
+  -c, --compile   生成完后自动执行 mwtsc --cleanOutDir
+      --only-entity  仅生成 entity 文件，不生成 DTO/VO/Service/Controller
+      --no-db     不尝试连库，使用模板字段模式
+      --db-host   数据库 host
+      --db-port   数据库端口（默认 3306）
+      --db-user   数据库用户名
+      --db-pass   数据库密码
+      --db-name   数据库名
+  -h, --help      显示帮助信息
+
+配置文件支持（按优先级从高到低）：
+  --src 指向的目录或 cwd 下查找：
+  - crud.config.ts / crud.config.js / crud.config.mjs / crud.config.cjs
+  - .crudrc / .crudrc.json / .crudrc.yaml / .crudrc.yml / .crudrc.js
+  - .config/crudrc / .config/crudrc.json
+  - package.json 中的 "crud" 字段
+
+配置文件示例（crud.config.ts）：
+  export default {
+    baseSrcPath: './src',
+    outputPath: './src',
+    db: {
+      host: '127.0.0.1',
+      port: 3306,
+      user: 'root',
+      password: '',
+      database: 'mydb',
+    },
+  }
+
+示例：
+  shys-crud --module home --table sys_dept
+  shys-crud --module order --table order_info --force
+  shys-crud -m home -t city -s ./packages/webtest/src --db-name world
 `);
 }
 function parseArgs(argv) {
@@ -153,6 +153,15 @@ async function askIfMissing(cli, config) {
         if (!cli.onlyEntity && config.onlyEntity) {
             cli.onlyEntity = true;
         }
+        if (!cli.hooks && config.hooks) {
+            cli.hooks = config.hooks;
+        }
+        if (!cli.baseFieldNames && config.baseFieldNames) {
+            cli.baseFieldNames = config.baseFieldNames;
+        }
+        if (!cli.excludeWritableFields && config.excludeWritableFields) {
+            cli.excludeWritableFields = config.excludeWritableFields;
+        }
     }
     finally {
         rl.close();
@@ -279,6 +288,7 @@ export async function runCli(argv = process.argv.slice(2)) {
         onlyEntity: cli.onlyEntity,
         baseFieldNames: cli.baseFieldNames,
         excludeWritableFields: cli.excludeWritableFields,
+        hooks: cli.hooks,
     });
     console.log(`\n${chalk.cyan(`生成清单（${built.files.length}）`)}`);
     const stats = writeAll(built.files, { force: !!cli.force, dryRun: !!cli.dryRun });

package/dist/config.js

@@ -111,6 +111,8 @@ export function mergeConfigs(...configs) {
             result.baseFieldNames = config.baseFieldNames;
         if (config.excludeWritableFields !== undefined)
             result.excludeWritableFields = config.excludeWritableFields;
+        if (config.hooks !== undefined)
+            result.hooks = { ...(result.hooks || {}), ...config.hooks };
         if (config.db) {
             result.db = { ...(result.db || {}), ...config.db };
         }

package/dist/generator.d.ts

@@ -1,4 +1,4 @@
-import type { FieldInfo, OrmInfo } from './types.js';
+import type { CrudHooks, FieldInfo, OrmInfo } from './types.js';
 import { TemplateRenderer } from './renderer.js';
 export interface BuildResult {
     files: Array<{
@@ -25,5 +25,6 @@ export interface BuildFilesParams {
     onlyEntity?: boolean;
     baseFieldNames?: string[];
     excludeWritableFields?: string[];
+    hooks?: CrudHooks;
 }
 export declare function buildFiles(params: BuildFilesParams): BuildResult;

package/dist/generator.js

@@ -166,13 +166,44 @@ function enhanceField(f, extra = {}) {
     };
 }
 export function buildFiles(params) {
-    const { moduleName, tableName, baseSrcPath, ormInfo, fields, outputPath, templatesPath, renderer: customRenderer, onlyEntity, baseFieldNames, excludeWritableFields, } = params;
+    const { moduleName, tableName: rawTableName, baseSrcPath, ormInfo, fields: rawFields, outputPath, templatesPath, renderer: customRenderer, onlyEntity, baseFieldNames, excludeWritableFields, hooks, } = params;
+    const tableName = hooks?.customTableName
+        ? hooks.customTableName(rawTableName)
+        : rawTableName;
+    let fields = rawFields;
+    if (hooks?.customFields) {
+        fields = hooks.customFields(fields);
+    }
+    if (hooks?.customField || hooks?.customFieldName) {
+        fields = fields
+            .map((f) => {
+            let field = { ...f };
+            if (hooks?.customFieldName) {
+                const newName = hooks.customFieldName(field.name);
+                if (newName !== field.name) {
+                    field.name = newName;
+                    field.camel = toCamelCase(newName);
+                }
+            }
+            if (hooks?.customField) {
+                const result = hooks.customField(field);
+                if (result === null)
+                    return null;
+                field = { ...field, ...result };
+            }
+            return field;
+        })
+            .filter(Boolean);
+    }
     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 rawPascal = toPascalCase(tableName);
+    const Pascal = hooks?.customEntityName
+        ? hooks.customEntityName(rawPascal)
+        : rawPascal;
     const CreateName = `Create${Pascal}Dto`;
     const UpdateName = `Update${Pascal}Dto`;
     const ReplaceName = `Replace${Pascal}Dto`;
@@ -245,13 +276,30 @@ export function buildFiles(params) {
     const sortableBase = [...entityFields, ...pkFields]
         .filter(f => !isSensitive(f))
         .map(f => f.camel);
-    const sortable = [...new Set([...pkCamels, ...sortableBase])];
+    let sortable = [...new Set([...pkCamels, ...sortableBase])];
     const filterableBase = [...entityFields, ...pkFields].filter(f => !isSensitive(f));
-    const filterableArr = [...new Map([...pkFields, ...filterableBase].map(f => [f.camel, f])).values()];
-    const filterable = filterableArr.map(f => f.camel);
-    const searchable = filterableArr
+    let filterableArr = [...new Map([...pkFields, ...filterableBase].map(f => [f.camel, f])).values()];
+    let filterable = filterableArr.map(f => f.camel);
+    let searchable = filterableArr
         .filter(f => /char|varchar|text/i.test(f.type))
         .map(f => f.camel);
+    if (hooks?.queryFields) {
+        const hookResult = hooks.queryFields(tableName, fields, Pascal, {
+            sortable,
+            filterable,
+            searchable,
+        });
+        if (hookResult) {
+            if (hookResult.sortable !== undefined)
+                sortable = hookResult.sortable;
+            if (hookResult.filterable !== undefined) {
+                filterable = hookResult.filterable;
+                filterableArr = fields.filter(f => filterable.includes(f.camel));
+            }
+            if (hookResult.searchable !== undefined)
+                searchable = hookResult.searchable;
+        }
+    }
     const enhancedCreateFields = createFields.map(f => enhanceField(f));
     const enhancedWritable = writable.map(f => enhanceField(f));
     const enhancedFilterable = filterableArr.map(f => enhanceField(f));

package/dist/types.d.ts

@@ -20,6 +20,7 @@ export interface CrudConfig {
     onlyEntity?: boolean;
     baseFieldNames?: string[];
     excludeWritableFields?: string[];
+    hooks?: CrudHooks;
 }
 export interface CliOptions extends CrudConfig {
     help?: boolean;
@@ -36,6 +37,23 @@ export interface FieldInfo {
     defaultVal: any;
     comment: string;
 }
+export interface QueryFieldsResult {
+    sortable?: string[];
+    filterable?: string[];
+    searchable?: string[];
+}
+export interface CrudHooks {
+    customEntityName?: (tableName: string) => string;
+    customFieldName?: (fieldName: string) => string;
+    customField?: (field: FieldInfo) => FieldInfo | null;
+    customFields?: (fields: FieldInfo[]) => FieldInfo[];
+    customTableName?: (tableName: string) => string;
+    queryFields?: (tableName: string, fields: FieldInfo[], pascal: string, defaultQuery: {
+        sortable: string[];
+        filterable: string[];
+        searchable: string[];
+    }) => QueryFieldsResult | void;
+}
 export interface OrmInfo {
     orm: string;
     ormSuffix: string;

package/package.json

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

package/templates/controller.njk

@@ -1,65 +1,65 @@
-import { Inject } from '@midwayjs/core';
-import { YSController, CrudPiped } from '@shys/core';
-import { {{ Pascal }} } from '../entity/{{ Camel }}.entity';
-import { {{ ServiceName }} } from '../service/{{ Camel }}.service';
-import {
-  {{ CreateName }},
-  {{ UpdateName }},
-  {{ ReplaceName }},
-  {{ QueryName }},
-} from '../dto/{{ Camel }}';
-import { {{ VOName }}, {{ ListVOName }} } from '../vo/{{ Camel }}';
-
-@YSController({
-  tagName: {{ tagName | json }},
-  description: {{ desc | json }},
-})
-@CrudPiped({
-  model: {{ Pascal }},
-  service: {{ ServiceName }},
-  id: {{ idField | json }},
-  dto: {
-    create: {{ CreateName }},
-    update: {{ UpdateName }},
-    replace: {{ ReplaceName }},
-    query: {{ QueryName }},
-  },
-  serialize: {
-    get: {{ VOName }},
-    list: {{ ListVOName }},
-    create: {{ VOName }},
-    update: {{ VOName }},
-  },
-  routes: {
-    only: ['list', 'detail', 'create', 'update', 'replace', 'delete'],
-  },
-  query: {
-    maxLimit: 100,
-    defaultLimit: 10,
-    sortable: [{{ sortable }}],
-    filterable: [{{ filterable }}],
-    searchable: [{{ searchable }}],
-    defaultSort: {{ defaultSort }},
-  },
-  piped: {
-    create: {
-      enabled: true,
-      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
-      validate: { enabled: true, errorStatus: 422 },
-    },
-    update: {
-      enabled: true,
-      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
-      validate: { enabled: true, errorStatus: 422 },
-    },
-    replace: {
-      enabled: true,
-      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
-      validate: { enabled: true, errorStatus: 422 },
-    },
-  },
-})
-export class {{ CtrlName }} {
-  @Inject()
-  crudService: {{ ServiceName }};
-}
+import { Inject } from '@midwayjs/core';
+import { YSController, CrudPiped } from '@shys/core';
+import { {{ Pascal }} } from '../entity/{{ Camel }}.entity';
+import { {{ ServiceName }} } from '../service/{{ Camel }}.service';
+import {
+  {{ CreateName }},
+  {{ UpdateName }},
+  {{ ReplaceName }},
+  {{ QueryName }},
+} from '../dto/{{ Camel }}';
+import { {{ VOName }}, {{ ListVOName }} } from '../vo/{{ Camel }}';
+
+@YSController({
+  tagName: {{ tagName | json }},
+  description: {{ desc | json }},
+})
+@CrudPiped({
+  model: {{ Pascal }},
+  service: {{ ServiceName }},
+  id: {{ idField | json }},
+  dto: {
+    create: {{ CreateName }},
+    update: {{ UpdateName }},
+    replace: {{ ReplaceName }},
+    query: {{ QueryName }},
+  },
+  serialize: {
+    get: {{ VOName }},
+    list: {{ ListVOName }},
+    create: {{ VOName }},
+    update: {{ VOName }},
+  },
+  routes: {
+    only: ['list', 'detail', 'create', 'update', 'replace', 'delete'],
+  },
+  query: {
+    maxLimit: 100,
+    defaultLimit: 10,
+    sortable: [{{ sortable }}],
+    filterable: [{{ filterable }}],
+    searchable: [{{ searchable }}],
+    defaultSort: {{ defaultSort }},
+  },
+  piped: {
+    create: {
+      enabled: true,
+      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
+      validate: { enabled: true, errorStatus: 422 },
+    },
+    update: {
+      enabled: true,
+      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
+      validate: { enabled: true, errorStatus: 422 },
+    },
+    replace: {
+      enabled: true,
+      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
+      validate: { enabled: true, errorStatus: 422 },
+    },
+  },
+})
+export class {{ CtrlName }} {
+  @Inject()
+  crudService: {{ ServiceName }};
+}

package/templates/dto-index.njk

@@ -1,4 +1,4 @@
-export * from './create.dto';
-export * from './update.dto';
-export * from './replace.dto';
-export * from './query.dto';
+export * from './create.dto';
+export * from './update.dto';
+export * from './replace.dto';
+export * from './query.dto';

package/templates/dto-query.njk

@@ -1,17 +1,17 @@
-import { ApiPropertyOptional } from '@midwayjs/swagger';
-import { Rule } from '@midwayjs/validation';
-import * as Joi from 'joi';
-import { CrudBaseQueryDto } from '../../../../framework/dto/base.query.dto';
-
-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 }},
-  })
-  @Rule({{ f.joiRule }}.optional())
-  {{ f.camel }}?: {{ f.jsType }};
-
-{% endfor -%}
-}
+import { ApiPropertyOptional } from '@midwayjs/swagger';
+import { Rule } from '@midwayjs/validation';
+import * as Joi from 'joi';
+import { CrudBaseQueryDto } from '../../../../framework/dto/base.query.dto';
+
+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 }},
+  })
+  @Rule({{ f.joiRule }}.optional())
+  {{ f.camel }}?: {{ f.jsType }};
+
+{% endfor -%}
+}

package/templates/service.njk

@@ -1,20 +1,20 @@
-{% if ormInfo.orm === 'typeorm' -%}
-import { Provide, Scope, ScopeEnum } from '@midwayjs/core';
-import { InjectEntityModel } from '@midwayjs/typeorm';
-import { Repository } from 'typeorm';
-import { BaseTypeOrmCrudService } from '@shys/core';
-import { {{ Pascal }} } from '../entity/{{ Camel }}.entity';
-
-@Provide()
-@Scope(ScopeEnum.Request, { allowDowngrade: true })
-export class {{ ServiceName }} extends BaseTypeOrmCrudService<{{ Pascal }}> {
-  @InjectEntityModel({{ Pascal }})
-  repo: Repository<{{ Pascal }}>;
-}
-{%- else -%}
-// {{ ormInfo.orm }} Service 模板（请按项目注入方式调整）
-import { Provide } from '@midwayjs/core';
-
-@Provide()
-export class {{ ServiceName }} {}
-{%- endif %}
+{% if ormInfo.orm === 'typeorm' -%}
+import { Provide, Scope, ScopeEnum } from '@midwayjs/core';
+import { InjectEntityModel } from '@midwayjs/typeorm';
+import { Repository } from 'typeorm';
+import { BaseTypeOrmCrudService } from '@shys/core';
+import { {{ Pascal }} } from '../entity/{{ Camel }}.entity';
+
+@Provide()
+@Scope(ScopeEnum.Request, { allowDowngrade: true })
+export class {{ ServiceName }} extends BaseTypeOrmCrudService<{{ Pascal }}> {
+  @InjectEntityModel({{ Pascal }})
+  repo: Repository<{{ Pascal }}>;
+}
+{%- else -%}
+// {{ ormInfo.orm }} Service 模板（请按项目注入方式调整）
+import { Provide } from '@midwayjs/core';
+
+@Provide()
+export class {{ ServiceName }} {}
+{%- endif %}