fix(check-tag-names): work with the constructor tag
#899
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tschaub
commented
Aug 2, 2022
| @@ -10,6 +10,12 @@ describe('jsdocUtils', () => { | |||
| it('returns the primary tag name', () => { | |||
| expect(jsdocUtils.getPreferredTagName({}, 'jsdoc', 'return')).to.equal('returns'); | |||
| }); | |||
| it('works with the constructor tag', () => { | |||
| expect(jsdocUtils.getPreferredTagName({}, 'jsdoc', 'constructor')).to.equal('class'); | |||
There was a problem hiding this comment.
Without the src change, this test fails with expected [Function Object] to equal 'class'.
tschaub
commented
Aug 2, 2022
| }); | ||
| }); | ||
| it('works with tags that clash with prototype properties', () => { | ||
| expect(jsdocUtils.getPreferredTagName({}, 'jsdoc', 'toString')).to.equal('toString'); |
There was a problem hiding this comment.
Without the src change, this test fails with expected [Function toString] to equal 'toString'.
|
🎉 This PR is included in version 39.3.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
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 [#​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 ([#​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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes it so the
check-tag-namesrule works when JSDoc tag names matchObject.prototypeproperties (like@constructor).Fixes #898.