hosseinmd / prettier-plugin-jsdoc

A Prettier plugin to format JSDoc comments.
MIT License
232 stars 28 forks source link

The remarks tag formatting is inconsistent #213

Open mcaroff-wallix opened 1 year ago

mcaroff-wallix commented 1 year ago

I get one of two formats depending on the system I'm on:

Windows: (flat):

/**
 * @remarks
 * text
 */

Linux: (indented):

/**
 * @remarks
 *   text
 */

Note: this issue may actually not be related to the OS, it may be due to something else.

Environment

.prettierrc.js:

{
  tsdoc: true
}

Versions:

    "prettier-plugin-jsdoc": "1.0.2",
    "prettier": "3.0.3",

Edit: added names "(flat)" and "(indented)", to format results.

hosseinmd commented 11 months ago

Hi dear, What is your node version?

mcaroff-wallix commented 11 months ago

Hi hosseinmd, it turns my node version is different on my two OS-es:

> # windows
> node --version
v16.20.1
$ # linux
$ node --version
v20.6.1

I also looked in our Gitlab CI, where this issue first appeared. We have this:

$ node -v
v16.16.0

Somehow the formatting produced in my Linux VM has changed and is now (flat), the same as on my Windows:

/**
 * @remarks
 * text
 */