valid-types rule complains about @requires #840

adp-psych · 2022-02-17T08:15:34Z

I have this at the top of a file:

/**
 * @file The scenarios of the experiment.
 *
 * @module module:scenarios/scenarios
 * @requires scenarios/effects
 * @author Anthony Di Pietro <anthony.dipietro@research.uwa.edu.au>
 * @copyright © 2020, 2021 Anthony Di Pietro
 * @license AGPL-3.0-or-later
 */

When I run ESLint, I get the following warning:

/home/user/.projects/psychology-phd/experiments/3/src/scenarios/scenarios.js
  22:0  warning  Syntax error in namepath: scenarios/effects  jsdoc/valid-types

I don’t understand why I’m getting this warning, and I wonder whether it might be spurious.

What should I do about this?

The text was updated successfully, but these errors were encountered:

… `module:`; fixes gajus#840" This reverts commit 32c1597.

fixes gajus#840

gajus · 2022-02-17T09:14:51Z

🎉 This issue has been resolved in version 37.9.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

brettz9 · 2022-02-17T09:16:54Z

Thanks for the report. In cases where module: was omitted, we had not been supplying our types parser with a copy that did have the module: path (so it could confirm the path was valid). Now fixed.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | devDependencies | patch | [`37.9.1` -> `37.9.2`](https://renovatebot.com/diffs/npm/eslint-plugin-jsdoc/37.9.1/37.9.2) | --- ### Release Notes <details> <summary>gajus/eslint-plugin-jsdoc</summary> ### [`v37.9.2`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v37.9.2) [Compare Source](gajus/eslint-plugin-jsdoc@v37.9.1...v37.9.2) ##### Bug Fixes - **`valid-types`:** ensure `requires` checking works without `module:`; fixes [#840](gajus/eslint-plugin-jsdoc#840) ([0cfdfd7](gajus/eslint-plugin-jsdoc@0cfdfd7)) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1177 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

brettz9 added the bug label Feb 17, 2022

brettz9 closed this as completed in 32c1597 Feb 17, 2022

brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Feb 17, 2022

Revert "test(valid-types): ensure requires checking works without…

9e78b57

… `module:`; fixes gajus#840" This reverts commit 32c1597.

brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Feb 17, 2022

fix(valid-types): ensure requires checking works without module:;

0cfdfd7

fixes gajus#840

gajus added the released label Feb 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Sponsors

valid-types rule complains about @requires #840

valid-types rule complains about @requires #840

adp-psych commented Feb 17, 2022

gajus commented Feb 17, 2022

brettz9 commented Feb 17, 2022

valid-types rule complains about @requires #840

valid-types rule complains about @requires #840

Comments

adp-psych commented Feb 17, 2022

gajus commented Feb 17, 2022

brettz9 commented Feb 17, 2022