Skip to content

Export Comments as JSDoc comments for interfaces #292

Description

@will-weiss

Hello! I first want to start by expressing my gratitude for kysely-codegen! It's a huge part of Virtual Hospitals Africa's ability to move quickly and ensure that any tables we define in our migrations are 1:1 with how they are used in kysely and our typescript code. Bravo!

One idea that might improve the project could be to export comments on tables as JSDoc comments with comments on the tables appearing above their corresponding interfaces in the db.d.ts file. This way if those interfaces are themselves imported in other files, those files could see what those tables/interfaces represent.

Thanks for your consideration!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions