microsoft / microsoft/TypeScript

Codefix: convert `Type[]` to `readonly Type[]`

Aperta
#31,923 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

Search Terms

codefix readonlyarray readonly array immutable

Suggestion

It'd be nice to have a codefix for converting non-readonly arrays to readonly.

Use Cases

When converting/refactoring code to be more immutable/readonly-friendly, it's a bit of a pain to manually add these annotations.

Examples

Given this:

function takesArrays(items: /*| |*/string[], moreItems: /*| |*/string[]) { /* ... */ }

...having a codefix to make one or all parameters readonly would be useful:

function takesArrays(items: readonly string[], moreItems: readonly string[]) { /* ... */ }

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Parti dagli esempi TypeScript dell’issue e dall’infrastruttura di codefix esistente per le annotazioni di tipo correlate. Individua l’entry point del codefix e i relativi test, quindi implementa la conversione per uno o per tutti i parametri applicabili e verifica che i tipi risultanti utilizzino la sintassi degli array readonly.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers, tooling
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.