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

require-hyphen-before-param-description: False-positive for hyphenated first word #665

Closed
kevinoid opened this issue Jan 3, 2021 · 3 comments

Comments

@kevinoid
Copy link

kevinoid commented Jan 3, 2021

Expected behavior

jsdoc/require-hyphen-before-param-description: ["error", "never"] is not triggered by @param {!Array<string>} argv Command-line arguments..

Actual behavior

index.js
  3:0  error  There must be no hyphen before @param description  jsdoc/require-hyphen-before-param-description

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

ESLint Config

{
  "plugins": [
    "jsdoc"
  ],
  "rules": {
    "jsdoc/require-hyphen-before-param-description": ["error", "never"]
  }
}

ESLint sample

/** Entry point for module.
 *
 * @param {!Array<string>} argv Command-line arguments.
 */
function main(argv) {
};

Environment

  • Node version: v12.19.0
  • ESLint version v7.17.0
  • eslint-plugin-jsdoc version: 30.7.11

Additional Notes

I am also able to reproduce the issue in 30.7.10, but not 30.7.9. It appears to be a regression in 30.7.10.

Thanks,
Kevin

@kevinoid
Copy link
Author

kevinoid commented Jan 3, 2021

Thanks for the lightning-fast fix @brettz9!

@brettz9
Copy link
Collaborator

brettz9 commented Jan 3, 2021

Thanks for the lightning fast report! :-)

@gajus
Copy link
Owner

gajus commented Jan 3, 2021

🎉 This issue has been resolved in version 30.7.13 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Jan 3, 2021
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