microsoft / microsoft/TypeScript
@import suggestions for auto-imports in VS Code
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
🔍 Search Terms
@import, auto-import, JSDoc
✅ Viability Checklist
- 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, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
Taken from a chat with @andrewbranch:
When working a JS codebase, it's common to want to import types. As of TS 5.5 we have the JSDoc @import tag which is wonderful!
However, VS Code does not offer it as an option for auto imports. Consider the following help menu:
I like the Change 'Customer' to 'import... suggestion, what I'd like even more would be a suggestion to Add /** @import {Customer} from ...
📃 Motivating Example
It doesn't improve the language. It improves the developer experience of JSDoc.
💻 Use Cases
- What do you want to use this for?
Working in VS Code more effectively. - What shortcomings exist with current approaches?
Current suggestions are more verbose. - What workarounds are you using in the meantime?
Writing imports by hand.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit dem vorhandenen VS Code-Hilfemenü für automatische Importe und dem im Issue beschriebenen Vorschlag „Change 'Customer'...“. Verfolgen Sie, wie dieser Vorschlag für JavaScript-Dateien erzeugt wird, fügen Sie anschließend eine entsprechende JSDoc @import-Option hinzu und überprüfen Sie, dass sie für den zugrunde liegenden Typimport-Fall angezeigt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript, vscode
- Bereich
- developer-experience, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100