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-param-names should have a contexts option like the rest of the rules do #897

Closed
Zamiell opened this issue Jul 25, 2022 · 2 comments
Closed

Comments

@Zamiell
Copy link
Contributor

Zamiell commented Jul 25, 2022

I believe that check-param-names should have a contexts option like the rest of the rules do.
That fact that it does not already have this seems to be an oversight.
Please implement this; it should be a simple fix!

This is needed in order to get a lint error for the following common situation:

/**
 * @param barr This is the description of bar. Oops, we misspelled "bar" as "barr".
 */
declare function foo(bar: number) {}
@brettz9
Copy link
Collaborator

brettz9 commented Aug 8, 2022

I don't think we want to consider this as an oversight with there being no custom contexts for this rule and other function-only rules because checking all of the function contexts is intended and should be sufficient.

However, we were missing TSDeclareFunction as a default context to check, causing the sample code not to be reported as expected. That is now fixed.

@gajus
Copy link
Owner

gajus commented Aug 8, 2022

🎉 This issue has been resolved in version 39.3.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Aug 8, 2022
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this issue Aug 12, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | devDependencies | patch | [`39.3.4` -> `39.3.6`](https://renovatebot.com/diffs/npm/eslint-plugin-jsdoc/39.3.4/39.3.6) |

---

### Release Notes

<details>
<summary>gajus/eslint-plugin-jsdoc</summary>

### [`v39.3.6`](https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v39.3.6)

[Compare Source](gajus/eslint-plugin-jsdoc@v39.3.5...v39.3.6)

##### Bug Fixes

-   ensure `TSDeclareFunction` is checked by default where function contexts are expected; closes [#&#8203;897](gajus/eslint-plugin-jsdoc#897) ([25d2a7f](gajus/eslint-plugin-jsdoc@25d2a7f))

### [`v39.3.5`](https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v39.3.5)

[Compare Source](gajus/eslint-plugin-jsdoc@v39.3.4...v39.3.5)

##### Bug Fixes

-   **`check-tag-names`:** constructor tag and tagNamePreference ([#&#8203;899](gajus/eslint-plugin-jsdoc#899)) ([4f8d242](gajus/eslint-plugin-jsdoc@4f8d242))

</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).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xNTEuMiIsInVwZGF0ZWRJblZlciI6IjMyLjE1MS4yIn0=-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1495
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>
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