hosseinmd / prettier-plugin-jsdoc

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

Formatting issue with `@remarks` tag when using list items #201

Closed Gykonik closed 1 year ago

Gykonik commented 1 year ago

The output is improperly indented when formatting comments with the @remarks tag and using list items. Instead of preserving the original list format, additional indentation is included.

Example:

/**
 * Just a simple test
 *
 * @remarks
 *   - Remark 1
 *   - Remark 2
 *   - Remark 3
 */

Formatted Result:

/**
 * Just a simple test
 *
 * @remarks
 *   - Remark 1
 * 
 *       - Remark 2
 *       - Remark 3
 */

I'm unsure whether my configurations are off, or this is a bug. My configurations are as follows:

"options": {
  "jsdocSeparateTagGroups": true,
  "tsdoc": true
}
hosseinmd commented 1 year ago

Release v1.0.2