Skip to content

Fix docs build: restore pg_interval_in and .js import extensions#7

Open
estebanzimanyi wants to merge 1 commit into
MobilityDB:mainfrom
estebanzimanyi:fix/docs-restore-interval-and-import-extensions
Open

Fix docs build: restore pg_interval_in and .js import extensions#7
estebanzimanyi wants to merge 1 commit into
MobilityDB:mainfrom
estebanzimanyi:fix/docs-restore-interval-and-import-extensions

Conversation

@estebanzimanyi

Copy link
Copy Markdown
Member

Restores the push-triggered docs build across three changes.

.js import extensions

The functions_ts_header.ts.template imports carry explicit .js extensions (../runtime/meos.js, ./errors.js), so the generated functions.generated.ts resolves under typedoc/vitepress nodenext module resolution.

pg_interval_in

pg_interval_in is declared in pgtypes.h, not a public meos_*.h umbrella header, so the MEOS-API catalog (run.py ingests meos/include only) does not carry it. Temporal depends on it, so it is wrapped by hand in the C preamble and the TS header, forward-declaring the pgtypes symbol (resolved from libpgtypes.a at link time).

Banner source

The generator emits the do not edit banner into its outputs, keeping it out of the hand-edited source templates so the templates read as plain editable source.

The track-master port (MobilityDB#6) regressed the push-triggered docs build in two
ways:

- The generated functions.generated.ts imports lost their `.js` extensions.
  The committed file carried them, but the template did not, so regenerating
  dropped them and typedoc/vitepress (nodenext resolution) failed with TS2835.
  Add the extensions to the template imports so regeneration keeps them.

- pg_interval_in disappeared. It is declared in pgtypes.h, not a public
  meos_*.h umbrella header, so the MEOS-API catalog (run.py ingests
  meos/include only) never contained it; the previous in-repo extractor did.
  It is used by Temporal, so its loss broke the build with TS2305. Wrap it by
  hand in the C preamble and the TS header, forward-declaring the pgtypes
  symbol (resolved from libpgtypes.a at link time).

Also emit the "do not edit" banner from the generator instead of storing it
in the hand-edited source templates, so the templates are plainly editable
source and the generated outputs still carry the marker.

`npm run docs:build` passes (0 errors).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant