Quick fix to convert @typedef to type or interface

Offen
#31,500 2 Kommentare 7 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript, typescript
Bereich
compilers

Rechercherichtung

Das Issue enthält keine Repository-Dateien, Tests oder Einstiegspunkte. Beginne mit der Überprüfung der TypeScript-quick-fix-Architektur und der vorhandenen JSDoc-bezogenen codefixes und ermittle anschließend die erwartete Konvertierung für das gezeigte @typedef-Beispiel. Erledigt bedeutet, dass ein quickfix unterstützte JSDoc-typedefs in einen type oder ein interface konvertiert, ohne die Runtime-Ausgabe zu ändern.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Awaiting More Feedback Suggestion

Search Terms

  • typedef quickfix
  • typedef jsdoc

Suggestion

I have lots of code in an old Closure Compiler-style project that looks like this:

/**
 * @typedef {{
 *   px: number,
 *   py: number,
 *   isZooming: boolean,
 *   isPanning: boolean,
 *   is2DPan: boolean,
 *   cancelNextDblclick: boolean,
 *   initializeMouseDown: (e: !Event, dygraph:!DygraphAny, context: !DygraphInteractionContext) => void
 * }} DygraphInteractionContext
 */

If I declare a variable with this type, I can see that TypeScript understands the @typedef:

type DygraphInteractionContext = {
    px: number;
    py: number;
    isZooming: boolean;
    isPanning: boolean;
    is2DPan: boolean;
    cancelNextDblclick: boolean;
    initializeMouseDown: (e: Event, dygraph: any, context: ...) => void;
}

I'd like to convert this to a type or interface. I can introduce a dummy variable, copy the TS-style type declaration and paste it in to do the conversion.

But it'd be easier if there were a quickfix!

Use Cases

Migrating a project that used JSDoc-based typing. A workaround is available, but a quickfix would be a big improvement.

Examples

(see above)

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.
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus microsoft/TypeScript

Alle Issues in microsoft/TypeScript

Ähnliche Issues

Weitere Issues zu Go

Neue Issues direkt in Ihr Postfach

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