microsoft / microsoft/TypeScript
typedef imports should use default exports
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
checkJs typedef import
Suggestion
When the module ./core.controller has a default export defined, I would like to be able to do:
/**
* @typedef { import("./core.controller") } Chart
*/
Instead of:
/**
* @typedef { import("./core.controller").Chart } Chart
*/
Use Cases
My file had defined export default Chart;.
TypeScript made me add a duplicate export, which I don't want to have to add
export {
Chart
};
This resulted in lots of extra code
It also took me an extremely long amount of time to figure out I needed to do this because the documentation did not mention this as a limitation.
Examples
Already shared in the above sections.
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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 with the TypeScript handbook's import types section and the existing JSDoc typedef import forms shown in the issue. Trace how a default-exported module is represented and tested, then confirm that the shorter import form is accepted without requiring a duplicate named export and that the documentation describes the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100