(1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import

BugDomain: JSDocHelp Wanted

Repository-Metriken

Stars: (48.455 Stars)
PR-Merge-Metriken: (Durchschn. Merge 6T 17h) (9 gemergte PRs in 30 T)

Beschreibung

Bug Report

2022-02-16T20:50:15.000Z

# 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: 2. ```ts /** * @param c * @param b * * bla bla bla */ function add(a, b) { } ``` 2. 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: ```js /** * @param b * * bla bla bla */ function add(a, b) { } ``` ### Related issues - #47922

🔎 Search Terms

quick fix
code action
jsdoc

🕗 Version & Regression Information

4.7.0-dev.20220216

This is new behavior and not a regression

💻 Repo

For the TypeScript:

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

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
Schwierigkeit: 2
Geschätzte Zeit: 1-3 Stunden
Aktivitätsstatus: Aktiv
Klarheit: Klar
Voraussetzungen: Keine
Einsteigerfreundlichkeit: 60