feat(build): add dual CJS+ESM build and TypeScript declarations#442
Open
lukeundtrug wants to merge 1 commit intosourcegraph:mainfrom
Open
feat(build): add dual CJS+ESM build and TypeScript declarations#442lukeundtrug wants to merge 1 commit intosourcegraph:mainfrom
lukeundtrug wants to merge 1 commit intosourcegraph:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This is more just a proposal and concrete details should be discussed. I forked scip-typescript because I wanted to use it in a project of mine as a library. Especially the TS types from scip.ts are very interesting to me and I would like to use them.
The current build doesn't emit declarations which is why I chose tsup to build a full CJS + ESM build which now also exposes the types to consumers.
I would appreciate some feedback if you would consider a direction like this. The package as a library, not just a CLI would definitely make sense.
The changes in this PR are breaking, nevertheless, because the current build doesn't bundle anything. I could also try to make it 100% backwards-compatible though. I still chose to go for breaking changes because I think it's a worthwhile discussion to have, which direction the package should go in the future.
Test plan
Ran local tests to ensure behavior remained unchanged.
Solves issue: #443