microsoft / microsoft/TypeScript

Expose more internal api for making language service plugins.

Offen
#36,252 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

language service plugin api refactor codefix vscode

Suggestion

  • ts.refactor.registerRefactor
    A more standard way to make refactor rather than hook the language servies functions.
    And refactor is a rare api that I do not need to write ui code or command for vscode.
  • ts.textChanges.*
    Use this, I can easily generate code or modify code that conform the current code format style.
    Especially you don't expose the ts.formatting.*
  • ts.TypeChecker.getTrueType() ts.TypeChecker.getFalseType()
    The TypeFlags.BooleanLiteral is not enough to determine it is true or false.

Use Cases

https://github.com/heroboy/generate-typescript-switch-case-for-enum-type-language-service-plugin

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 der Prüfung der APIs der TypeScript Language Service Plugins und der angeforderten Einstiegspunkte: ts.refactor.registerRefactor, ts.textChanges., ts.formatting. und TypeChecker.getTrueType()/getFalseType(). Vergleiche sie mit dem verlinkten Anwendungsfall generate-typescript-switch-case-for-enum-type-language-service-plugin; für den Abschluss ist ein abgegrenzter, abgestimmter Vorschlag für eine öffentliche API erforderlich, statt alle aufgeführten Anforderungen zu implementieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers, devtools
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

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