v0.19.0

New features

Thanks to amazing contributions from@​kevinmichaelchen in#​274, you can now override types on a global level:

.kysely-codegenrc.json

{"customImports": {"InstantRange":"./custom-types","CustomDuration":"@​my-org/custom-types#Duration","Temporal":"@​js-temporal/polyfill",  },"typeMapping": {"timestamptz":"Temporal.Instant","tstzrange":"InstantRange","date":"Temporal.PlainDate","interval":"CustomDuration"  }}

Example of generated output:

importtype{InstantRange}from'./custom-types';importtype{DurationasCustomDuration}from'@&#8203;my-org/custom-types';importtype{Temporal}from'@&#8203;js-temporal/polyfill';exportinterfaceEventModel{createdAt:Temporal.Instant;dateRange:ColumnType<InstantRange,InstantRange,never>;eventDate:Temporal.PlainDate;interval:CustomDuration;}exportinterfaceDB{events:EventModel;}

What's Changed

• fix(GH-240): crash caused by undeclared dependency by@​FaberVitale in#​241
• chore(deps): allow kysely 0.28.0 and tedious 19 by@​belgattitude in#​256
• feat: export config types by@​Omar-Awawdeh in#​252
• chore(pnpm): pnpm v10.9.0, set onlyBuiltDependencies by@​belgattitude in#​254
• README: Pin@​tediousjs/connection-string to 0.5.0 by@​yuriy-sng in#​279
• Fix peer dep range by@​joefatora in#​268
• Add missing cli arg "config-file" to documentation by@​SimonSimCity in#​263
• Fix inconsistencies between VS Code settings and Prettier configuration by@​anonpay-sh in#​265
• feat: Support imports for custom types by@​kevinmichaelchen in#​274

New Contributors

• @​FaberVitale made their first contribution in#​241
• @​belgattitude made their first contribution in#​256
• @​Omar-Awawdeh made their first contribution in#​252
• @​yuriy-sng made their first contribution in#​279
• @​joefatora made their first contribution in#​268
• @​SimonSimCity made their first contribution in#​263
• @​anonpay-sh made their first contribution in#​265
• @​kevinmichaelchen made their first contribution in#​274

Full Changelog:RobinBlomberg/kysely-codegen@0.18.0...0.19.0

v0.18.0

Compare Source

Migration to 0.18.0

The follow CLI options have been changed:

• --schema has been renamed to--default-schema.
• --singular has been renamed to--singularize.
• --runtime-enums and--runtime-enums-style have been merged into a single CLI option--runtime-enums.

Configuration file

All codegen options can also be configured in a.kysely-codegenrc.json (or.js,.ts,.yaml etc.) file or thekysely-codegen property inpackage.json. SeeCosmiconfig for all available configuration file formats.

The default configuration:

{"camelCase":false,"dateParser":"timestamp","defaultSchemas": [],// ["public"] for PostgreSQL."dialect":null,"domains":true,"envFile":null,"excludePattern":null,"includePattern":null,"logLevel":"warn","numericParser":"string","outFile":"./node_modules/kysely-codegen/dist/db.d.ts","overrides": {},"partitions":false,"print":false,"runtimeEnums":false,"singularize":false,"typeOnlyImports":true,"url":"env(DATABASE_URL)","verify":false}

The configuration object adds support for more advanced options:

{"camelCase":true,"overrides": {"columns": {"users.settings":"{ theme: 'dark' }"    }  },"singularize": {"/^(.*?)s?$/":"$1_model","/(bacch)(?:us|i)$/i":"$1us"  }}

The generated output:

exportinterfaceUserModel{settings:{theme:'dark'};}// ...exportinterfaceDB{bacchi:Bacchus;users:UserModel;}

Custom serializers and dialects

The new configuration support also adds support for supplying custom serializers.

Here is a stub example of a basic Zod serializer (.kysely-codegenrc.ts):

import{toKyselyCamelCase}from'../../generator';importtype{Config}from'../config';constconfig:Config={logLevel:'debug',outFile:null,serializer:{serializeFile:(metadata)=>{letoutput='import { z } from "zod";\n\n';for(consttableofmetadata.tables){output+='export const ';output+=toKyselyCamelCase(table.name);output+='Schema = z.object({\n';for(constcolumnoftable.columns){output+='  ';output+=column.name;output+=': ';switch(column.dataType){case'int4':output+='z.number().int()';break;default:output+='z.unknown()';}output+=',\n';}output+='});\n\n';}returnoutput;},},url:'postgres://user:password@localhost:5433/database',};exportdefaultconfig;

Example output:

import{z}from"zod";exportconstusersSchema=z.object({baz_qux:z.number().int(),});

Similarly, it's also possible to supply a customdialect value, allowing you to create a completely new kysely-codegen dialects or extending an existing one with extra logic.

What's Changed

• feat!: Merge "runtime-enums" and "runtime-enums-style" options
• feat!: Deprecate "schemas" option and rename it to "defaultSchemas"
• feat!: Rename "singular" option to "singularize"
• feat: Support kysely-codegen configuration files (usingcosmiconfig)
• feat: Add support for custom singularization rules
• feat: Merge all...IdentifierNode classes into a singleIdentifierNode class
• feat: AddskipAutogenerationFileComment serializer option
• fix: Fixoverrides not always applying to the correct column
• fix: Fix test flakiness by running all tests in sequence
• fix: Make bun sqlite codegen work again (re-introduce KyselyBunSqliteIntrospectorDialect using the sqlite database from bun:sqlite and the Kysely dialect from 'kysely-bun-sqlite') by@​meck93 in#​238
• fix: Fix update function example @​ README. by@​igalklebanov in#​227
• chore: Upgrade all dependencies
• chore: Allow@​libsql/kysely-libsql@​^0.4.1 as a peer dependency@​alsiola in#​233

New Contributors

• @​meck93 made their first contribution in#​238
• @​alsiola made their first contribution in#​233

Full Changelog:RobinBlomberg/kysely-codegen@0.17.0...0.18.0

v0.17.0

What's Changed

• fix: fix incorrect timestamp types (fixes#​203,#​209)
• feat: support named instances for Microsoft Sql Server by@​gittgott in#​204
• feat: add --date-parser flag to control Postgres DATE type by@​brianmcd in#​210 (fixes#​177,#​194)
• docs: list current cli args by@​shane-js in#​167
• docs: update README.md run instructions by@​shane-js in#​166
• docs: improve documentation (fixes#​178)
• feat(cli): adjust flag descriptions (fixes#​193)
• feat: improve error when.env file is missing

New Contributors

• @​brianmcd made their first contribution in#​210
• @​shane-js made their first contribution in#​167

Full Changelog:RobinBlomberg/kysely-codegen@0.16.7...0.17.0