hosseinmd / prettier-plugin-jsdoc

A Prettier plugin to format JSDoc comments.
MIT License
228 stars 29 forks source link

when appending "default description" to description, imported types are repeated #229

Open boneskull opened 6 months ago

boneskull commented 6 months ago

Given:

/**
 * A thing that does stuff
 * @template {any[]} [T=import('foo').Something]
 * @param {T} values Stuff.
 */
function doStuff (values) {
}

Invoking prettier will result in this:

/**
 * A thing that does stuff
 * @template {any[]} [T=import('foo').Something] Default is `import('foo').Something`
 * @param {T} values Stuff. 
 */
function doStuff (values) {
}

But if we invoke prettier again, we get this:

/**
 * A thing that does stuff
 * @template {any[]} [T=import('foo').Something] Default is `import('foo').Something` Default is `import('foo').Something`
 * @param {T} values Stuff. 
 */
function doStuff (values) {
}

And again:

/**
 * A thing that does stuff
 * @template {any[]} [T=import('foo').Something] Default is `import('foo').Something` Default is `import('foo').Something` Default is `import('foo').Something`
 * @param {T} values Stuff. 
 */
function doStuff (values) {
}

(linebreaks will be added to the description of values as well)

This does not happen if we do, e.g.,:

/**
 * @typedef {import('foo').Something} Something
 */

/**
 * A thing that does stuff
 * @template {any[]} [T=Something]
 * @param {T} values Stuff.
 */
function doStuff (values) {
}

This results in:

/**
 * A thing that does stuff
 * @template {any[]} [T=Something]  Default is `Something`
 * @param {T} values Stuff.
 */
function doStuff (values) {
}

Subsequent prettier invocations will not cause Default is Something to be repeated.

This may be difficult to reproduce and I'm still trying to isolate it. It may only apply to docstrings for a class (not a function), or if @implements is present.