Modularize the library for external use of internal function #620
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
wokalski
approved these changes
Aug 12, 2025
| import { TypedSqlTagTransformer } from './typedSqlTagTransformer.js'; | ||
| import { TypescriptAndSqlTransformer } from './typescriptAndSqlTransformer.js'; | ||
| import { debug } from './util.js'; | ||
| export const debug = debugBase('pg-typegen'); |
There was a problem hiding this comment.
Suggested change
| export const debug = debugBase('pg-typegen'); | |
| const debug = debugBase('pg-typegen'); |
Comment on lines
-3
to
-26
| import type { Category } from '../customTypes.js'; | ||
|
|
||
| export type categoryArray = (Category)[]; | ||
| /** 'SqlSelectFromBooksWhereIdId' parameters type */ | ||
| export interface ISqlSelectFromBooksWhereIdIdParams { | ||
| id?: number | null | void; | ||
| } | ||
|
|
||
| /** 'SqlSelectFromBooksWhereIdId' return type */ | ||
| export interface ISqlSelectFromBooksWhereIdIdResult { | ||
| author_id: number | null; | ||
| categories: categoryArray | null; | ||
| id: number; | ||
| name: string | null; | ||
| rank: number | null; | ||
| } | ||
|
|
||
| /** 'SqlSelectFromBooksWhereIdId' query type */ | ||
| export interface ISqlSelectFromBooksWhereIdIdQuery { | ||
| params: ISqlSelectFromBooksWhereIdIdParams; | ||
| result: ISqlSelectFromBooksWhereIdIdResult; | ||
| } | ||
|
|
||
| export function sql(s: `SELECT * FROM books WHERE id = $id`): ReturnType<typeof sourceSql<ISqlSelectFromBooksWhereIdIdQuery>>; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With the release of pglite, one could really benefit from running a postgres (pglite) instance and pgtyped in a single script. This PR makes it easier by exposing an internal function from pgtyped for processing a single file with minimal configuration.
Most of the "modularize" work was to just divide the
@pgtyped/clipackage into two packages:@pgtyped/cliand a new package@pgtyped/typegenwhich is only responsible for generating TS types code and unlimitedly exposes a single functiongetTypeswhich processes a single file. This function is then used by the CLI and can be used by the user.I also divided the config so the the typegen function only takes arguments that it really needs.
There is actually much more we can do with pglite in terms of types generation. With the right changes we probably don't even need to establish any TCP connection when working with pglite instance to generate types.