Skip to content

Blacklisting tags via tagNamePreference causes false errors #332

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.

Sign up for GitHub

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

Jump to bottom
Closed
jaydenseric opened this issue Jul 12, 2019 · 2 comments
Closed

Blacklisting tags via tagNamePreference causes false errors #332

jaydenseric opened this issue Jul 12, 2019 · 2 comments
Assignees
@brettz9
Labels
bug released

Comments

@jaydenseric
Copy link
Contributor

jaydenseric commented Jul 12, 2019 •
edited
Loading

With:

{
    "settings": {
        "jsdoc": {
            "tagNamePreference": {
                "description": false
            }
        }
    }
}

The jsdoc/require-description rule reports an Unexpected tag `@description` error, highlighting the whole JSDoc comment block, for every block regardless if @description is present.

With:

{
    "settings": {
        "jsdoc": {
            "tagNamePreference": {
                "implements": false
            }
        }
    }
}

The same thing happens, but with the jsdoc/implements-on-classes rule and an Unexpected tag `@implements` error.

Screen Shot 2019-07-12 at 6 33 23 pm

I am attempting to ban both of those tags and more via tagNamePreference, to match the jsdoc-md list of supported tags.

Those two tags are the only ones that seem to cause rules to break.
@brettz9 brettz9 added the bug label Jul 12, 2019
@brettz9 brettz9 self-assigned this Jul 12, 2019
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 13, 2019
@brettz9
testing(require-param): fix test expectation (part of gajus#332)
be771ec
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 13, 2019
@brettz9
testing(require-param): fix test source (part of gajus#332)
9fab87c
brettz9 added a commit to interfaced/eslint-plugin-jsdoc that referenced this issue Jul 14, 2019
@brettz9
Merge branch 'master' into add-more-type-checks-to-valid-types
78a0cba 
* master: (46 commits)
  feat(require-description-complete-sentence): limit checking to certain default tags likely to have descriptions or by `tags` array for additional choices; fixes gajus#337
  docs(newline-after-description): indicate applies on doc block
  docs(match-description): add alias `desc` to separate column
  docs(match-description): indicate application by default to `description`/`desc` and allowance for `property`/`prop`; clarify
  fix(match-description): ensure `prop` and `property` matching excludes name
  testing(require-param): fix test source (part of gajus#332)
  testing(require-param): fix test expectation (part of gajus#332)
  docs: generate docs
  chore: update devDeps (eslint-config-canonical, gitdown)
  fix(no-undefined-types): ensure working in all contexts; fixes gajus#324
  refactor(iterateJsdoc): reduce retrieval calls
  docs(check-examples): allow for whitespace at end
  feat(check-examples): add `paddedIndent` option
  fix(check-examples): preserve whitespace so as to report issues with whitespace-related rules such as `indent` (fixes gajus#211)
  chore(travis): fix Travis to use older unicorn version that supports Node 6 (and the canonical config that requires the earlier unicorn version)
  docs(require-returns, require-returns-check): indicate that these will report if multiple `returns` tags are present
  refactor: use `String.prototype.repeat` over lodash `repeat`
  refactor: apply (jsdoc-related) eslint rule fixes
  chore: add `lint-fix` script
  fix(newline-after-description): avoid matching duplicate or partial matches within tag descriptions after the block description; fixes gajus#328
  ...
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 14, 2019
@brettz9
fix(require-description, implements-on-classes, check-param-names, ch…
78c22c9 
…eck-tag-names, require-param, require-returns, require-returns-check): only report blocking of tag by user if problematic tag is present; fixes gajus#332
@brettz9 brettz9 mentioned this issue Jul 14, 2019
Merged
@gajus
Copy link
Owner

gajus commented Jul 14, 2019

🎉 This issue has been resolved in version 15.5.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Jul 14, 2019
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 14, 2019
@brettz9
Merge branch 'master' into add-more-type-checks-to-valid-types
602d210 
* master:
  fix(match-description, require-description-complete-sentence): do not report blocking of tag by user for `description` tag (the tag is not required by these rules)
  fix(require-description): only report blocking of description tag by user if "tag" option is set
  fix(require-description, implements-on-classes, check-param-names, check-tag-names, require-param, require-returns, require-returns-check, require-hyphen-before-param-description, require-param-description, require-param-name, require-param-type, require-returns-description, require-returns-type): only report blocking of tag by user if problematic tag is present; fixes gajus#332
jaydenseric added a commit to jaydenseric/eslint-config-env that referenced this issue Jul 15, 2019
@jaydenseric
Update eslint-plugin-jsdoc and remove a redundant workaround.
6ebe9e1 
See: gajus/eslint-plugin-jsdoc#332
jaydenseric added a commit to jaydenseric/eslint-config-env that referenced this issue Jul 15, 2019
@jaydenseric
Update eslint-plugin-jsdoc and remove a redundant workaround.
0004142 
See: gajus/eslint-plugin-jsdoc#332
@gajus
Copy link
Owner

gajus commented Sep 1, 2019

🎉 This issue has been resolved in version 15.9.0 🎉

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
Assignees

@brettz9 brettz9

Labels
bug released
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@brettz9 @gajus @jaydenseric