Skip to content

Commit f32b9ea

Browse files
committed
docs(parser): Add types bundling documentation to PUBLISH.md
- Document that parser is self-contained with bundled types - Explain the types bundling process - Note that no external @pgsql/types dependency is needed
1 parent 9c3e632 commit f32b9ea

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

PUBLISH.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,13 @@ cd parser
249249
npm run build:lts # or build:full, build:latest, etc.
250250
```
251251

252+
### Types Bundling
253+
The parser build process automatically:
254+
1. Copies TypeScript type definitions from `types/*/dist/` directories
255+
2. Places them in `wasm/v*/types/` for each version
256+
3. Updates all import references from `@pgsql/types` to `./types`
257+
4. Makes the package self-contained without external type dependencies
258+
252259
### Publishing with Different Tags
253260

254261
```bash
@@ -271,6 +278,7 @@ npm publish --tag legacy
271278
- Supports different build configurations for different use cases
272279
- Includes both CommonJS and ESM builds
273280
- Exports version-specific parsers via subpaths (e.g., `@pgsql/parser/v17`)
281+
- **Self-contained**: Bundles TypeScript types locally (no external @pgsql/types dependency)
274282

275283
### Install published package
276284
```bash

0 commit comments

Comments
 (0)