Incorrect handling of default type parameter values produces infinite changes

[arthurgubaidullin]

Example of buggy code:

/**
 * @template [BAR=({bar:true}&{foo:false}&{buggy:true})] 
 * @typedef {{foo: BAR}} SomeType
 */

First formatting produces the following result:

/**
 * @template [BAR=({bar:true}&{foo:false}&{buggy:true})] Default is
 *   `({bar:true}&{foo:false}&{buggy:true})`
 * @typedef {{foo: BAR}} SomeType
 */

Second formatting produces the following result:

/**
 * @template [BAR=({bar:true}&{foo:false}&{buggy:true})] Default is
 *   `({bar:true}&{foo:false}&{buggy:true})`. Default is
 *   `({bar:true}&{foo:false}&{buggy:true})`
 * @typedef {{foo: BAR}} SomeType
 */

Third formatting produces the following result:

/**
 * @template [BAR=({bar:true}&{foo:false}&{buggy:true})] Default is
 *   `({bar:true}&{foo:false}&{buggy:true})`. Default is
 *   `({bar:true}&{foo:false}&{buggy:true})`. Default is
 *   `({bar:true}&{foo:false}&{buggy:true})`
 * @typedef {{foo: BAR}} SomeType
 */

And so on.

Prettier config:

{
  "bracketSpacing": false,
  "singleQuote": true,
  "plugins": ["./node_modules/prettier-plugin-jsdoc"]
}

Environment:

• prettier-plugin-jsdoc@0.4.2
• prettier@2.7.1

[arthurgubaidullin]

I think the problem is on this line. A possible line break is not checked.

prettier-plugin-jsdoc/src/parser.ts

Line 533 in d255d76

description = description.replace(/[ \t]*Default is `.*`\.?$/, "");

[levithomason]

I'd like to disable this feature altogether. It is unexpected for a formatter to write documentation for me. I don't want my jsdoc content changed, I only want it formatted.

The jsdoc in that file says that it is in place due to a TS issue, however, I'm not using TS and my IDE also shows the defaults already. So, the insertion is unnecessary. It is cluttering up the actual documentation in my case:

[hosseinmd]

Yes, you are right. This feature is for VS Code. I agree with you, this feature should be optional.

[wreckah]

Just want to clarify that such feature is already implemented, but is not referred in the docs:

module.exports = {
  plugins: ['prettier-plugin-jsdoc'],
  jsdocAddDefaultToDescription: false
};

[hosseinmd]

fixed: v1.0.5