sourcegraph / sourcegraph/scip-typescript
Build doesn't expose types - No good DX when using as a library
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 115
- Forks
- 42
- Avg merge
- 12d 22h
- Merged PRs (30d)
- 6
Description
Hi there, I opened #442 where I modernized the build chain a bit and introduced some breaking changes to the resulting artifact (index.ts files and exports map).
I'm using scip-typescript in my project as a library (creating scip-indexes programmatically from TS code). I wanted to use this package as a library, which is totally possible but the DX is lacking a bit since the package doesn't expose types although everything is fully typed internally.
Do you have any plans in making this more user-friendly for consumers?
The PR is merely a proposal with some opinions baked in. Feel free to give me your take on it, would love to discuss :)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing issue #442, especially the index.ts files and exports map changes that affected the package artifact. Check how the library is consumed programmatically and determine the public type exposure needed for a better consumer experience. Done means library consumers can access the package's types without relying on internal implementation details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100