chore(deps): update dependency eslint-plugin-jsdoc to v22 - autoclosed

[renovate]

This PR contains the following updates:

Package	Type	Update	Change
eslint-plugin-jsdoc	devDependencies	major	15.12.2 -> 22.2.0

---

Release Notes

gajus/eslint-plugin-jsdoc

v22.2.0

Compare Source

Features

• require-param: add contexts option; closes #​511 (3aaba73)

v22.1.0

Compare Source

Features

• require-returns: add checkGetter option to be able to disable enforcement on getters (eb3cc84)

v22.0.1

Compare Source

Bug Fixes

• require-jsdoc: ensure exemptEmptyFunctions doesn't attempt to apply when non-function contexts are in use (causing errors); fixes #​501 (7daf934)

v22.0.0

Compare Source

• chore; drop eslint 5 (3c9d20f)

BREAKING CHANGES

• Drops ESLint@5 support

v21.0.0

Compare Source

Bug Fixes

• check-param-names, check-property-names, require-file-overview: avoid direct use of uncertain license of object.entries-ponyfill; closes #​487 (4403fb0)

BREAKING CHANGES

• check-param-names, check-property-names, require-file-overview: Now requires Node >= 8

v20.4.0

Compare Source

Features

• require-returns-check: Allow @​return to be omitted with @​record tag in Closure mode (20b6ae0)

v20.3.1

Compare Source

Bug Fixes

• check-values: allow [@version](https://togithub.com/version) and [@since](https://togithub.com/since) to have versions surrounded by whitespace (37466a8)

v20.3.0

Compare Source

Features

• no-bad-blocks: add rule to check for multi-line-style comments which fail to meet criteria of a jsdoc block (4ce07d1)

v20.2.0

Compare Source

Features

• no-defaults: add new rule to reports defaults on [@param](https://togithub.com/param) or [@default](https://togithub.com/default) and optionally report optional args; fixes #​477 (d7fec9a)

v20.1.0

Compare Source

Features

• require-hyphen-before-param-description: add option to support checking property/prop (1383c02)

v20.0.5

Compare Source

Performance Improvements

• check-examples: avoid caching unused config (6cbf286)

v20.0.4

Compare Source

Bug Fixes

• no-types, require-param: fixable meta should be code not true (b0aed65)
• require-file-overview: omit fixable meta on non-fixable rule (efddc1c)

v20.0.3

Compare Source

Bug Fixes

• check-property-names: check duplicate nested names (1c31782)

v20.0.2

Compare Source

Bug Fixes

• check-param-names: check duplicate nested names; fixes #​474 (c51d616)

v20.0.1

Compare Source

Bug Fixes

• require-jsdoc: handle spread elements in typescript-eslint/parser; for #​378 (3e8ea59)

v20.0.0

Compare Source

Features

• check-examples: apply rules by default as if on current JavaScript file (though with md extension for easier automated overriding); fixes #​434 (976cfc1)

refactoring

• check-examples: rename eslintrcForExamples to checkEslintrc; also ensure matchingFileName always triggers config retrieval (5a85f0f)

BREAKING CHANGES

• check-examples: This commit also clarifies new precedence and behavior in docs.

v19.2.0

Compare Source

Features

• require-file-overview: allow user to specify whether checking for tag, duplicates, or preceding non-comments, and for which tags (f6e467e)

v19.1.0

Compare Source

Features

• no-types, implements-on-classes: add contexts option which if set to any will allow checking of virtual functions (c4079b8)
• require-param-*, require-returns-*, require-returns: allows contexts option to be set to "any" to check virtual function docs like [@callback](https://togithub.com/callback) or [@function](https://togithub.com/function) with [@interface](https://togithub.com/interface); fixes #​406 (7500b00)

v19.0.1

Compare Source

Bug Fixes

• require-file-overview: fix logic for detecting start of file (601e52d)

v19.0.0

Compare Source

Features

• check-property-names: add rule to check for duplicated and improperly nested properties (492b814)

• require-property*: add rules for ensuring property tags have a name, type, and/or description (in any context); fixes #​409 (e5f2a23)

• feat(require-property); add rule to check for property on typedef or namespace where the type is object; fixes #​410 (68bf6cd), closes #​410

BREAKING CHANGES

• check-property-names: Adds new rule to recommended
• require-property*: Adds rules to recommended
• Adds new rule to recommended config.

v18.11.0

Compare Source

Features

• match-description, require-description, require-example: allow "any" for contexts; fixes #​325 (50d3b4d)

v18.10.0

Compare Source

Features

• check-access: allow ignorePrivate setting to work with access private tag. (cf37cc6)

v18.9.0

Compare Source

Features

• check-types: add option exemptTagContexts to exempt type-checking (certain types or any types) on specific tags; fixes #​255 (5d99663)

v18.8.0

Compare Source

Features

• require-description-complete-sentence: add abbreviations option; fixes #​424 (f70fd6c)

v18.7.0

Compare Source

Features

• require-file-overview: add rule for every file to have a file tag; fixes #​55 (7839625)

v18.6.2

Compare Source

Bug Fixes

• empty-tags: ensure rule is still checked when a private tag is present despite even a true ignorePrivate setting. (c5b8e09)

v18.6.1

Compare Source

Bug Fixes

• ensure ignorePrivate setting works with iterateAllJsdocs rules (9703aba)

v18.6.0

Compare Source

Features

• require-jsdoc: allow simple decorators to intervene between comment block and context object; fixes part of #​455 (641479b)

v18.5.0

Compare Source

Features

• check-param-names: add option allowExtraTrailingParamDocs to avoid reporting additional [@param](https://togithub.com/param)'s beyond actual function's arguments; fixes #​450 (4532e66)

v18.4.4

Compare Source

Bug Fixes

• require-returns: should only report errors with async functions when forceReturnsWithAsync is set (13f5533)

v18.4.3

Compare Source

Bug Fixes

• require-param: update comment-parser to surface fix for asterisk followed immediately by non-space; add test; fixes #​443 (dd5f015)
• should apply corrected parse description for all rules as may otherwise parse previous tags differently (d6ccd45)

v18.4.2

Compare Source

Bug Fixes

• check-types: surface jsdoctypeparser fix for new() with arrow functions; @​Elberet (373fb43)

v18.4.1

Compare Source

Bug Fixes

• check-param-names: failure to handle default params with spacing; closes #​377 (c361ef6)

v18.4.0

Compare Source

Features

• check-examples: add no-multiple-empty-lines by default (67df3dd)

v18.3.0

Compare Source

Features

• validateDescription: tighten constraint (3b5e301)

v18.2.2

Compare Source

Bug Fixes

• valid-types: ensure reporting "must have a type" when type is known to be required (b36053e)
• valid-types: ensure when in closure mode, that this and define tags have types (b6e2699)

v18.2.1

Compare Source

Bug Fixes

• check-types, no-undefined-types, valid-types: look within curly brackets of this and define tags (and if present within export) when in Closure mode; fixes #​430 (7022f65)

v18.2.0

Compare Source

Features

• check-examples: support global regexes and other flags besides now default "u" (i.e., any of gimys); fixes #​331 (5587e02)

v18.1.6

Compare Source

Bug Fixes

• check-examples: only exclude optional initial space from description, not initial newline (needed for line counts, and rules) (0e89cc8)

v18.1.5

Compare Source

Bug Fixes

• newline-after-description: correctly treat carriage return immediately after newline as ending with a newline; fixes #​437 (2fd8ecc)
• newline-after-description: when finding last description line, don't look beyond the length of the description. (242202f)

v18.1.4

Compare Source

Bug Fixes

• ensure comment is only matched by /**\s at beginning of text (eeab3d2)

v18.1.3

Compare Source

Bug Fixes

• newline-after-description: only treat comments with whitespace after two asterisks only as jsdoc (3d61126)

v18.1.2

Compare Source

Bug Fixes

• newline-after-description: avoid erring on encountering sequence of carriage returns (or other non-whitespace) as sole content of jsdoc block description (fixes #​433) (e453b2d)

v18.1.1

Compare Source

Bug Fixes

• newline-after-description: handle carriage returns properly: fixes #​431 (a38b28b)

v18.1.0

Compare Source

Features

• check-values: add licensePattern option to allow delimiting portion of license description to extract (eed7dde)

v18.0.1

Compare Source

Bug Fixes

• check-values: check for whole SPDX expression, not only single identifiers (e058efa)

v18.0.0

Compare Source

Bug Fixes

• check-param-names: use ponyfill as such; avoid defining Object.entries when not present (ea1a626)

Features

• check-access: add rule to check access levels (f919d5a)
• empty-tags: expect certain tags to be empty (66ebda9)
• check-values: add new rule for checking special tag values (within version, since, license, author) (5543c29)

BREAKING CHANGES

• check-values: Adds to recommended.

1. @version - Checks that there is a present and valid
   semver version value.
2. @since - As with @version
3. @license - Checks that there is a present and valid SPDX identifier
   or is present within an allowedLicenses option.
4. @author - Checks there is a value present, and if the option
   allowedAuthors is present, ensure that the author value is one
   of these array items.

• check-access: New rule updates recommended

Checks @access for allowed values and prohibits multiple access
modifier tags on the same block

• empty-tags: Added rule to recommended.

May add additional tags to check for emptiness using tags option.

v17.1.2

Compare Source

Bug Fixes

• no-undefined-types: do not crash on variadic arguments (eaf41ed)
• no-undefined-types: properly parse template tag name(s) for defined types (5f48821)
• no-undefined-types: surface jsdoctypeparser update to avoid errors with empty variadic argument; closes #​419 (9124b7b)

v17.1.1

Compare Source

Bug Fixes

• require-description-complete-sentence: allow pipe symbol at beginning/end of sentences; fixes #​423 (0fb07c1)

v17.1.0

Compare Source

Features

• getJSDocComment: ignore line comment (9d24b25)

v17.0.1

Compare Source

Bug Fixes

• check-tag-names: ensure that the fenced block content of [@example](https://togithub.com/example) tags are not treated as jsdoc tags; fixes #​395 (bfa237b)

v17.0.0

Compare Source

Features

• no-undefined-types: only check [@template](https://togithub.com/template) in no-undefined-types for types in "closure" and "typescript" modes; fixes part of #​356 (7583f16)

BREAKING CHANGES

• no-undefined-types: @template has no special meaning for regular jsdoc (is not even allowed by default), so don't check in "jsdoc" mode.

v16.1.1

Compare Source

Bug Fixes

• check-tag-names: add record and undocumented tags in Closure source to Closure tags; fixes #​306 (42476b2)

v16.1.0

Compare Source

Features

• check-types, no-undefined-types, valid-types: with settings.jsdoc.mode, only expect types on certain tags if in "closure" mode (42e8de2)

v16.0.0

Compare Source

Features

• check-tag-names and other rules: begin settings.jsdoc.mode; utilize in getPreferredTagName, isValidTag, getTagsByType; fixes part of #​356 (fd36278)

BREAKING CHANGES

• check-tag-names and other rules: Allowable values: jsdoc|typescript|closure

---

Renovate 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, check this box

---

This PR has been generated by WhiteSource Renovate. View repository job log here.

[commit-lint]

Chore

• deps: update dependency eslint-plugin-jsdoc to v22 (feb1cef)

Contributors

@renovate-bot

[coveralls]

Coverage remained the same at 100.0% when pulling feb1cef on renovate/eslint-plugin-jsdoc-22.x into 9205484 on master.