Kysely-Codegen 0.18.0 版本发布:配置化与自定义能力的全面升级
Kysely-Codegen 是一个为 Kysely(TypeScript 的 SQL 查询构建器)自动生成类型定义的工具,它能够根据数据库结构自动生成对应的 TypeScript 类型,极大地提升了开发效率和类型安全性。最新发布的 0.18.0 版本带来了多项重要改进,特别是配置化和自定义能力的显著增强。
配置文件的全面支持
0.18.0 版本最大的变化之一是引入了对配置文件的全面支持。现在,开发者可以通过 .kysely-codegenrc 文件(支持 JSON、JS、TS、YAML 等多种格式)或在 package.json 中的 kysely-codegen 属性来配置所有代码生成选项,而不再局限于命令行参数。
这一改进使得项目配置更加集中和可维护,特别是对于需要复杂配置的大型项目。配置文件中可以设置包括表名转换规则、列类型覆盖、运行时枚举等所有选项。
配置选项的优化与重命名
新版本对一些 CLI 选项进行了重命名以提升一致性:
--schema重命名为--default-schema--singular重命名为--singularize--runtime-enums和--runtime-enums-style合并为单一的--runtime-enums
这些变化虽然需要开发者进行少量迁移工作,但使得选项命名更加清晰和一致。
高级表名转换规则
新版本增强了表名单数化(singularize)功能,现在支持通过正则表达式定义复杂的转换规则。例如:
{
"singularize": {
"/^(.*?)s?$/": "$1_model",
"/(bacch)(?:us|i)$/i": "$1us"
}
}
这种灵活性特别适合处理不规则复数形式或需要特定命名约定的项目。
自定义序列化器与方言支持
0.18.0 版本引入了强大的自定义序列化器功能,允许开发者完全控制生成的代码格式。例如,可以创建生成 Zod 模式的序列化器:
serializer: {
serializeFile: (metadata) => {
let output = 'import { z } from "zod";\n\n';
// 生成 Zod 模式定义...
return output;
}
}
同样,现在也支持自定义方言(dialect),这意味着开发者可以扩展或创建全新的数据库方言支持,为特殊数据库或定制需求提供了可能。
其他改进与修复
- 修复了列覆盖(overrides)不总是应用到正确列的问题
- 通过顺序执行测试解决了测试不稳定的问题
- 恢复了 bun sqlite 的代码生成支持
- 更新了所有依赖项
- 改进了文档中的示例
总结
Kysely-Codegen 0.18.0 通过引入配置文件支持、增强的自定义能力和多项优化,显著提升了工具的灵活性和易用性。这些改进使得它能够更好地适应各种项目需求,从简单的类型生成到复杂的自定义代码输出。对于已经在使用 Kysely 的团队来说,升级到这个版本将带来更顺畅的开发体验和更强的类型安全保障。