Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

check-line-alignment breaks if there is no @param type #714

Closed
MiK546 opened this issue Apr 26, 2021 · 1 comment
Closed

check-line-alignment breaks if there is no @param type #714

MiK546 opened this issue Apr 26, 2021 · 1 comment

Comments

@MiK546
Copy link

MiK546 commented Apr 26, 2021

The check-line-alignment rule, when run with the never option, seems to give an error about lines being aligned even if there is only one space between the @param tag, the parameter name and its description. If I add the type definition curly braces between @param and the parameter name the error disappears.

Expected behavior

No errors are given.

Actual behavior

The following error is given with the test code below:

/file/path/file.js
  2:0  error  Expected JSDoc block lines to not be aligned  jsdoc/check-line-alignment

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

ESLint Config

{
    "plugins": [
        "jsdoc"
    ],
    "rules": {
        "jsdoc/check-line-alignment": [
            2,
            "never"
        ]
    }
}

ESLint sample

/**
 * @param parameter Description.
 */
function func(parameter){

}

Environment

  • Node version: 12.22.1
  • ESLint version 7.25.0
  • eslint-plugin-jsdoc version: 32.3.1
@gajus
Copy link
Owner

gajus commented Apr 26, 2021

🎉 This issue has been resolved in version 32.3.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants