camelcase plugin does not work when column name include `_${number}`. about kysely HOT 9 CLOSED

It's not possible to make that work.

from kysely.

this is a bug, idk why it got closed.

from kysely.

create table company
(
    id               integer generated by default as identity
        constraint company_pk
            primary key,
    amount_spend_12m int
); 

you can try this ddl with camelcase plugin

There are two way to type this table.

interface Company {
  amountSpend12m: string
}

const rows = db
.selectFrom('company')
.select('amountSpend12m')
.compile()

// compiles to `select "amount_spend12m" from "company"`;
// this query produce error because amount_spend12m is not defined 

interface Company {
  amountSpend_12m: string
}
const rows = db
.selectFrom('company')
.select('amountSpend_12m')
.compile()

// compiles to `select "amount_spend_12m" from "company"`;
// the result actual shape is { amountSpend12m: number } but kysely infer it as { amountSpend_12m: number } 

How should we type such table? I already rename the column to something else without numbers, but this should be a bug in my opinion

from kysely.

The camel case plugin simply runs all identifiers (column names, table names etc.) through a toSnakeCase function and then the returned column names through a toCamelCase function. When kysely receives a column named amount_spend_12m from the db, how could it possibly know that it's supposed to transform it to a mixture of cameCase and snake_case amountSpend_12m?

We don't actually know which selects map to which returned columns. Figuring that out would be super difficult.

You can override the CamelCasePlugin:

 class MyCamelCasePlugin extends CamelCasePlugin {
   protected override camelCase(str: string): string {
     if (str === 'amount_spend_12m') {
       return 'amountSpend_12m'
     }
     return super.camelCase(str)
   }
 }

but it's not possible to make the default work the way you want. For example, how would Kysely know what to do when you run selectFrom('company').selectAll().limit(1).execute()?

from kysely.

if the column name is amount_spend_12m, how should user define it in typescript interface?

from kysely.

amountSpend12m

from kysely.

it doesn't work. kysely transform it to amount_spend12m

from kysely.

See the documentation https://koskimas.github.io/kysely/interfaces/CamelCasePluginOptions.html#underscoreBeforeDigits

from kysely.

And you're welcome for the free help once again!

from kysely.