[FEATURE]: Add TypeScript definitions for custom bundles
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 28
Description
Since plotly.js v4 includes built-in TypeScript definitions, it would be great if custom bundles could also generate matching TypeScript definitions.
This would make custom bundles safer and easier to use in TypeScript projects.
In my case, I sometimes use a custom bundle to test newly developed features before they are released. However, the custom bundle does not include corresponding type definitions, so I have to rely on the types from the latest released version.
This can lead to missing or mismatched types, especially when the custom bundle includes new APIs or features that are not yet available in the released version.
Contributor guide
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 tracing how custom bundles are generated and how the built-in TypeScript definitions are included in plotly.js v4. Define the expected matching output for a custom bundle, including APIs from unreleased features, and verify that the generated definitions reflect the bundle.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100