Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
hediet opened this issue May 28, 2024 · 0 comments
Open

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

hediet opened this issue May 28, 2024 · 0 comments

Comments

@hediet
Copy link
Member

hediet commented May 28, 2024

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

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

No branches or pull requests

1 participant