Microsoft/TypeScript

Delete unused JSDoc quick fix changes formatting on rest of JSDoc comment

Offen

#47.923 geöffnet am 16.02.2022

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (13.395 Forks)batch import
BugDomain: JSDocHelp Wanted

Repository-Metriken

Stars
 (108.860 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Bug Report

🔎 Search Terms

  • quick fix
  • code action
  • jsdoc

🕗 Version & Regression Information

4.7.0-dev.20220216

This is new behavior and not a regression

💻 Repo

  1. For the TypeScript:
/**
 * @param c
 * @param b
 * 
 * bla bla bla
 */
function add(a, b) { }
  1. Trigger the delete unused @param tag quick fix on c inside the JSDoc.

🙁 Actual behavior

This results in:

/**
 * @param b bla bla bla
 */
function add(a, b) { }

🙂 Expected behavior

I'd sped that only the @param c is removed and the rest of the jsdoc remains unchanged:

/**
 * @param b
 * 
 * bla bla bla
 */
function add(a, b) { }

Related issues

  • #47922

Contributor Guide

Research-Richtung
Untersuche die Schnellkorrektur 'Nicht verwendeten @param Tag löschen' in der TypeScript Codebasis, wahrscheinlich in src/services/codefixes/deleteUnusedJSDocParam.ts. Die Schnellkorrektur entfernt derzeit nur den Tag, fusioniert aber auch den folgenden Text (z. B. 'bla bla bla') mit dem nächsten Parameter. Untersuche, wie der Kommentartext nach dem Löschen rekonstruiert wird, und implementiere eine Änderung, um die ursprüngliche Formatierung beizubehalten, sodass nur die angegebene Tag Zeile entfernt wird. Erwäge die Verwendung der Quellmap oder AST Manipulation, um Zeilenumbrüche beizubehalten.
Tech Stack
typescript
Domain
developer experience
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60