microsoft / microsoft/TypeScript
Feature Request: Provide an option to configure the presentation of Arrays
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
Suggestion
Provide an option to configure the presentation of Arrays.
🔍 Search Terms
This suggestion is hard to search for ☹️
✅ 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 behaviour 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
I would like to see an option that will allow for altering the presentation of Arrays.
📃 Motivating Example
When reading through type errors or hovering over source code in VS Code, I find it hard to easily distinguish between Arrays, Tuples, Arrays of Tuples, Tuples with Arrays in them etc.
I personally use linting rules so that I know that when I see a [ or ] in my source code, I am explicitly dealing with a Tuple.
For example, I find Array<[Array<T>]> far easier to quickly parse than [T[]][]. This may simply be attributed to my bias of writing code in the generic form. Though, this gets worse with increased levels of nesting.
🎨 Prior art
The tslint rule array-type can be used to enforce using the generic form of Array<T>. Secondarily, this rule was also ported as the @typescript/eslint rule array-type.
💻 Use Cases
I find hovering over my own code and seeing it presented differently a bit frustrating. Consider the following playground screenshot:

In addition toarray-types options of "array", "generic", "array-simple", a fourth option of "preserve" could be added which would address the screenshot above.
I would like to suggest the following option:
| Flag | Type | Default value |
|---|---|---|
--arrayType |
"array" | "generic" | "array-simple" | "preserve" |
"preserve" |
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
Inizia con il playground TypeScript collegato e l'esempio di hover di VS Code per confrontare la presentazione attuale di array annidati e tuple. Esamina i valori richiesti di --arrayType e considera completato il lavoro quando la sintassi degli array viene preservata o formattata in modo coerente negli errori di tipo e nelle visualizzazioni hover, senza modificare il JavaScript emesso.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100