microsoft / microsoft/TypeScript
Warn about invalid triple slash directive location.
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
🔍 Search Terms
"triple slash directive warning", "triple slash directive", "triple slash"
✅ 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
Provide a warning when triple slash directives are found places where they are ignored.
eg.
import { AudioBuffer } from '@/audio/AudioBuffer';
/// <reference lib="WebWorker" />
Typescript could emit a warning on line 3 "triple slash directive is ignored due to not being first" and a quick fix to move it to the top.
This would provide clarity in the case that people don't remember (or haven't read) the docs.
📃 Motivating Example
I just spent 20 minutes with a file equivalent to the above trying to work out why the webworker types would only get included when i commented out my import statements. I thought it was some problem with imports specifically.
💻 Use Cases
- What do you want to use this for?
Save time trying to search for the wrong problem. - What shortcomings exist with current approaches?
People don't always read or remember what's documented. - What workarounds are you using in the meantime?
n/a
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Non vengono indicati file sorgente o test. Inizia individuando la gestione del compilatore per le direttive triple-slash e la relativa infrastruttura dei quick-fix del servizio linguistico. Il lavoro è completato quando le direttive ignorate producono un avviso con il testo richiesto e offrono una correzione che le sposta all'inizio, con una copertura per l'esempio di un import prima della direttiva.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100