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-param: Linting destructured parameters with partial jsdoc leads to odd roots #762

Closed
underflowdev opened this issue Jul 1, 2021 · 2 comments · Fixed by #1255 · May be fixed by WontonSam/markdownlint#22 or WontonSam/markdownlint#25

Comments

@underflowdev
Copy link

underflowdev commented Jul 1, 2021

Perhaps the answer here is "Don't do that".

Expected behavior

Linting with

  /**
   */
  quux({ foo }, { bar }) {
    console.log(foo, bar);
  }

results in

  /**
   * @param root0
   * @param root0.foo
   * @param root1
   * @param root1.bar
   */
  quux({ foo }, { bar }) {
    console.log(foo, bar);
  }

All good.

Actual behavior

Linting with

  /**
   * @param root0
   * @param root0.foo
   */
  quux({ foo }, { bar }) {
    console.log(foo, bar);
  }

results in

  /**
   * @param root0
   * @param root0.foo
   * @param root0.foo.bar
   */
  quux({ foo }, { bar }) {
    console.log(foo, bar);
  }

and accompanying warnings.

ESLint Config

jsdoc/recommended

ESLint sample

See above

Environment

  • Node version: v16.0.0
  • ESLint version v6.8.0
  • eslint-plugin-jsdoc version: 35.4.1

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@brettz9 brettz9 changed the title Linting destructured parameters with partial jsdoc leads to odd roots require-param: Linting destructured parameters with partial jsdoc leads to odd roots Jul 2, 2021
@brettz9
Copy link
Collaborator

brettz9 commented Jul 2, 2021

This might be connected to #540 even while the details differ.

Copy link

github-actions bot commented Jul 5, 2024

🎉 This issue has been resolved in version 48.5.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