microsoft / microsoft/TypeScript
JSDoc for file/directory autocompletion
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Suggestion
🔍 Search Terms
directory autocompletion
file autocompletion
path autocompletion
path intellisense
cwd autocompletion
✅ Viability 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, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
An new JSDoc like /* @ts-ignore */ for directory/file autocompletion for an folder (e.g. default: cwd)
e.g.:
Plugin Options:
interface PluginOptions {
/* @ts-path-autocompletion (optional define path; default: cwd) */
file: string
}
📃 Motivating Example
It can help to choose the path instead of typing it.
And maybe warn if the path does not exist. (Disabling would be handy for files and folders that are still being created)
💻 Use Cases
IntelliSense for an path in another folder for e.g. webpack plugin options.
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
Der Vorschlag erwähnt keine Dateien, Tests oder Einstiegspunkte. Beginne damit zu ermitteln, wo JSDoc-/Plugin-Optionen und die Pfadvervollständigung behandelt werden, und definiere dann vor der Implementierung das unterstützte Verhalten für Annotationen, den Pfadbereich und den Umgang mit fehlenden Dateien; abgeschlossen ist die Aufgabe, wenn die angeforderte Vervollständigung für die beschriebenen Anwendungsfälle funktioniert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- developer-experience
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100