microsoft / microsoft/TypeScript

Warn when JSDoc type cast misses parentheses

Offen
#28,993 1 Kommentar 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Domain: JSDoc In Discussion Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

Search Terms

jsdoc. type cast

Suggestion

JSDoc type cast currently requires parentheses for technical reasons (#18212), but it does not warn when they don't exist.

Use Cases

// This doesn't work, the JSDoc comment is silently ignored
// A warning message will help.
const img = /** @type {HTMLImageElement} */ document.getElementById('#cat')
img.src = 'cat.gif'

Examples

const img = /** @type {HTMLImageElement} */ document.getElementById('#cat')
            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
            ^ Warning: The JSDoc type cast misses parentheses and is being ignored
img.src = 'cat.gif'

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 in der Issue und der referenzierten Issue #18212 beschriebenen Verarbeitung von JSDoc-Typumwandlungen und finde anschließend die zugehörigen Diagnose- und Regressionstests. Die Änderung ist vollständig, wenn eine Typumwandlung ohne Klammern die gezeigte Warnung erzeugt, ohne die JavaScript-Ausgabe zu ändern, während Typumwandlungen in Klammern ihr bisheriges Verhalten beibehalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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