microsoft / vscode-prompt-tsx

MIT License
34 stars 1 forks source link

Use `dts-bundle` to export the public API in one d.ts file #43

Open hediet opened 5 months ago

hediet commented 5 months ago

Currently, the API that this package exposes consists of many d.ts files:

Code_-_Insiders_1e7z0mU02x

I recommend to only ship one d.ts file for the public API. This makes it much easier to control breaking changes, as it creates a boundary between internal and external (API) types. It also makes it much easier to check what functionality the library offers/exports. It also makes it easier to create a documentation page (e.g. https://microsoft.github.io/monaco-editor/docs.html) with other tools.

I can recommend to use this tool for bundling the dts files: https://github.com/TypeStrong/dts-bundle