[FEATURE]: Add TypeScript definitions for custom bundles
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript, typescript
- Domain
- build-system
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.
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.
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 22
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.
More from plotly/plotly.js
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
chore P3 plotly-internal size: 3 task
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
-
chore P1 plotly-internal size: 1 task
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
chore P3 plotly-internal size: 1 task
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
All issues in plotly/plotly.js
Similar issues
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
Mintplex-Labs/anything-llm#6490 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
[quality] workflow-scripts guard reads test:unit:coverage as skipping the unit suite, blocking #632 Openagent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
area-clientside-dartpad
Difficulty 2/5 1-3 hours Newbie friendliness 62/100