microsoft / microsoft/TypeScript

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

Offen
#31,923 1 Kommentar 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit den TypeScript-Beispielen des Issues und der vorhandenen codefix-Infrastruktur für verwandte Typannotationen. Identifiziere den codefix-Einstiegspunkt und seine Tests, implementiere dann die Konvertierung für einen oder alle zutreffenden Parameter und verifiziere, dass die resultierenden Typen die readonly-Array-Syntax verwenden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.