You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The check-line-alignment rule, with the always option, gives an error when there is only one space between the @param tag and the parameter name if there is no type definition in between. The same issue occurs with the @return tag in this context. The error goes away if there are instead 2 spaces between the tag and the next word.
I noticed issue #714 is similar, but that applies to the never option and only the @param tag.
Expected behavior
No errors are given.
The two spaces seems to be there for the type definition to go between, but in a Typescript project the jsdoc type definitions are redundant and unnecessary.
Actual behavior
The following error is given for either test case below:
Expected JSDoc block lines to be aligned jsdoc/check-line-alignment
This PR contains the following updates:
| Package | Type | Update | Change |
|---|---|---|---|
| [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | devDependencies | patch | [`39.3.2` -> `39.3.3`](https://renovatebot.com/diffs/npm/eslint-plugin-jsdoc/39.3.2/39.3.3) |
---
### Release Notes
<details>
<summary>gajus/eslint-plugin-jsdoc</summary>
### [`v39.3.3`](https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v39.3.3)
[Compare Source](gajus/eslint-plugin-jsdoc@v39.3.2...v39.3.3)
##### Bug Fixes
- **`check-line-alignment`:** if no types are present, avoid allocating extra space; fixes [#​891](gajus/eslint-plugin-jsdoc#891) ([26e7357](gajus/eslint-plugin-jsdoc@26e7357))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - 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.
---
- [ ] <!-- rebase-check -->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/1428
Reviewed-by: 6543 <6543@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
The
check-line-alignment
rule, with thealways
option, gives an error when there is only one space between the@param
tag and the parameter name if there is no type definition in between. The same issue occurs with the@return
tag in this context. The error goes away if there are instead 2 spaces between the tag and the next word.I noticed issue #714 is similar, but that applies to the
never
option and only the@param
tag.Expected behavior
No errors are given.
The two spaces seems to be there for the type definition to go between, but in a Typescript project the jsdoc type definitions are redundant and unnecessary.
Actual behavior
The following error is given for either test case below:
ESLint Config
ESLint sample
Environment
eslint-plugin-jsdoc
version: 39.3.2The text was updated successfully, but these errors were encountered: