renovate[bot]
commented
3 years ago Renovate Ignore Notification
As this PR has been closed unmerged, Renovate will ignore this upgrade and you will not receive PRs for any future 32.x releases. However, if you upgrade to 32.x manually then Renovate will then reenable updates for minor and patch updates automatically.
If this PR was closed by mistake or you changed your mind, you can simply rename this PR and you will soon get a fresh replacement PR opened.
This PR contains the following updates:
^30.7.9->^32.0.1Release Notes
gajus/eslint-plugin-jsdoc
### [`v32.0.1`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v32.0.1) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v32.0.0...v32.0.1) ##### Bug Fixes - default to `u` flag for `checkTypesPattern` option for `require-param`, `check-param-names`; for `check-values`, default to `u` flag and allow slashed regexes with own flags; for `match-description`, allow slashed regexs with own flags; for all of the previous (and `check-examples`) allows newlines ([4f0dc8e](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/4f0dc8ee7d50860050eccf7b0484d409315c006b)) ### [`v32.0.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v32.0.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.6.1...v32.0.0) ##### Bug Fixes - **check-examples:** change default extension for simulated file name of `[@example](https://togithub.com/example)` from `md` to `md/*.js`. Only applies when `matchingFileName` is not used. ([2cc1227](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/2cc12279f35f0136e6b3a68c7d19ae8719e7a061)) ##### BREAKING CHANGES - **check-examples:** Per update to `eslint-plugin-markdown` v2 and its support of ESLint 7's new processor API, fenced blocks can (and must) be targeted separately from the Markdown parent file as a whole, so in order to allow the same `overrides` config to be reusable between Markdown fenced blocks and `@example` tags (since one often wishes to disable the same kind of rules for each, being as that each may deliberately lack full context, e.g., undefined or unused variables), we update the default simulated extension set for `@example` tags by `check-examples` to simulate an expression which will now be a suitable choice for `overrides` in targeting Markdown fenced blocks using the new parser API, as with eslint-plugin-markdown@2 (i.e., "md/\*.js" instead of "md"). If you need to use ESLint 6 (or eslint-plugin-markdown < 2, for example) with `check-examples`, you should be able to manually supply the `matchingFileName` option targeting "md", e.g., set to `'dummy.md`. This commit also simplifies a testing example to avoid it throwing with changed config not having proper babel support (not meaningful to test anyways) ### [`v31.6.1`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.6.1) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.6.0...v31.6.1) ##### Bug Fixes - update `comment-parser`; fixes [#686](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/686) ([7e0bbbe](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/7e0bbbe82eb4a1d0b0c603ed0c78bd6e685dee20)) ### [`v31.6.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.6.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.5.0...v31.6.0) ##### Bug Fixes - **`require-returns`, `require-yields`:** support more AST checking ([6fd8a07](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/6fd8a070c12a30eec8ccca5486446a06331a3d45)) - **`require-yields`:** avoid checking nested generators (as with functions) ([b9058e4](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/b9058e493640289e4a585e48a2dad810f0c170a4)) - **`return-yields`, `return-yields-check`:** allow generator detection on exported; handle more AST types; fixes [#682](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/682) ([4e768aa](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/4e768aaed4c9fd28496af910e147183a950ce6a1)) ##### Features - **`require-returns-check`:** add `exemptAsync` option ([0ed24c0](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/0ed24c049919757c15ec80e06e4be8686524c47b)) ### [`v31.5.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.5.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.4.0...v31.5.0) ##### Bug Fixes - **`require-returns`:** check labeled statements ([51f37f1](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/51f37f10774ff3d9cd33faecdf829e83610700c5)) - **`require-throws`:** check labeled statements ([ceadcfe](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/ceadcfe7fed67af579fb2de6fb0df8aefe37a115)) - **`require-yields`:** check `test` part of if expression and check conditionals ([db001be](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/db001bebad9ef1b5a27297142fd328cbcc86759f)) - **`require-yields`:** check labeled statements ([aceb7a0](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/aceb7a096fadc13939163ec1b77b03e771002477)) ##### Features - **`require-returns`:** if function returns a Promise whose executor resolves with undefined, avoid need to document unless `forceReturnsWithAsync` is set; fixes [#550](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/550) ([565fdbd](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/565fdbd410db2127f8272d0896a6768a4a8c95d0)) ### [`v31.4.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.4.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.3.3...v31.4.0) ##### Bug Fixes - **`check-line-alignment`:** escape user tag name in regex ([c0ae4cb](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/c0ae4cb193f643b321329d008d4eff80d4ea485a)) ##### Features - **`check-line-alignment`:** allow `tags` option to configure which tags should be aligned. ([780b8b5](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/780b8b50888db2196ec420157b9d3092c202b079)) ### [`v31.3.3`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.3.3) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.3.2...v31.3.3) ##### Bug Fixes - **`check-line-alignment`:** apply alignment to return tags and avoid possibility for "never" option to insert extra space with `returns`/`return` as well as handle missing type ([cb39556](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/cb39556cb69be6c9a32e8a2acd725bcd2f354d31)) ### [`v31.3.2`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.3.2) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.3.1...v31.3.2) ##### Bug Fixes - while a fix provided for decorator detection and useful for inserting empty jsdoc blocks when fixers are enabled, it appears to have a 25% or so degradation in performance when tested with a large repository, so reverting. ([e08d889](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/e08d8891ffbfe15b78830ea6b10230e12df13906)) ##### Reverts - Revert "optimize: ensure with new fix that we avoid checking back too far" ([0fc4663](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/0fc466363224e45d2e9b638f124782e0e0d4c40d)) ### [`v31.3.1`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.3.1) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.3.0...v31.3.1) ##### Bug Fixes - bug with false positive decorator detection (evident sans semi-colons); e.g., `require-jsdoc` fixer ([6bda6b4](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/6bda6b47d267982914581bfc03b4de50c9d0da07)) ### [`v31.3.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.3.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.2.3...v31.3.0) ##### Features - **`check-param-names`:** add options `disableExtraPropertyReporting` to allow extra properties to be documented without error (as long as there are no siblings destructured as for such cases, they will still be expected since the function is not using them) ([8b2d143](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/8b2d143e6201fe271b45debbc6c43bcabc03f6a1)) ### [`v31.2.3`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.2.3) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.2.2...v31.2.3) ##### Bug Fixes - **`require-param`, `check-param-names`:** add option `useDefaultObjectProperties` for expecting documentation or avoiding reporting of documented; addresses part of [#676](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/676) ([a36faf2](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/a36faf24005346e0d07cb43c1128ba4ced658b0a)) ### [`v31.2.2`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.2.2) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.2.1...v31.2.2) ##### Bug Fixes - **`check-tag-names`:** should have previously auto-allowed `settings.jsdoc.structuredTags` tags ([5f586fd](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/5f586fdc10d4619ea98242900ae1444d2babe018)) ### [`v31.2.1`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.2.1) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.2.0...v31.2.1) ##### Bug Fixes - caps issue with require-yields-check rule ([6b8d0d8](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/6b8d0d826f08655393eacc29d8d90470fa014571)) ### [`v31.2.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.2.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.1.0...v31.2.0) ##### Features - **`require-yields-check`:** add rule to check that `yield` (of proper form) is present in the function body; fixes [#354](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/354) ([acf9529](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/acf95295b62bfb3a88af93df36c350204604d439)) ### [`v31.1.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.1.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.8...v31.1.0) ##### Features - **`require-yields`:** add new rule to check that `yield` has documentation; for [#354](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/354) ([e06fddd](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/e06fddd65a6529ad683dae0ad0dbb903e78a7fc6)) - **`require-yields`:** add options to check that `next` has documentation ([15daa12](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/15daa12ef23ee4f51d6dbe8385cccdaf868668df)) ### [`v31.0.8`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.8) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.7...v31.0.8) ##### Bug Fixes - **`no-undefined-types`:** support `true` and `false` literals ([b8cb394](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/b8cb394876af03512791a44c9efad10d46e43703)) ### [`v31.0.7`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.7) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.6...v31.0.7) ##### Bug Fixes - ensure accurate parsing of names after multi-line types; fixes [#669](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/669) ([7b9c1bd](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/7b9c1bd8766b60df55dc324ec4848dbb9020eb7c)) ### [`v31.0.6`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.6) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.5...v31.0.6) ##### Bug Fixes - update `comment-parser` to surface restoration of support for equal signs in defaults and multi-line types; fixes [#669](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/669); fixes [#673](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/673) ([081d7eb](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/081d7eb63eb5b1022f2ce6a93760ab82f13a8307)) ### [`v31.0.5`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.5) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.4...v31.0.5) ##### Bug Fixes - **`require-description-complete-sentence`:** regression re: not trimming of description for check as relevant to tag description checking; fixes [#672](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/672) ([d81caa2](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/d81caa2ee88610e4c7c015bc84ad712e3f57d3cd)) ### [`v31.0.4`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.4) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.3...v31.0.4) ##### Bug Fixes - restore trim as relevant to tag description checking; fixes [#670](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/670) ([9f69c36](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/9f69c366e3da081c27b93b7954d7c5e4d15932e4)) ### [`v31.0.3`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.3) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.2...v31.0.3) ##### Bug Fixes - **`newline-after-description`:** handle description on same line as opening asterisks; fixes [#668](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/668) ([040d177](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/040d1773983aef155f40b63fe9af3a2689eec0ed)) ### [`v31.0.2`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.2) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.1...v31.0.2) ##### Bug Fixes - **`check-line-alignment`:** implement default `never` options; fixes [#483](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/483) ([b2db226](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/b2db2266c15510ab0f8155831a0fbc1128e717bd)) ### [`v31.0.1`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.1) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v31.0.0...v31.0.1) ##### Bug Fixes - **`check-line-alignment`:** handle spaces in type and skip for single line ([@renatho](https://togithub.com/renatho)); closes [#638](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/638) ([577863b](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/577863bbb2bbceaa8daa9bf83b7b0c26a6836e33)) ### [`v31.0.0`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v31.0.0) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v30.7.13...v31.0.0) ##### chore - update comment-parser; should now cause fixers to preserve original whitespace unless the rule is meant to fix it ([095ff36](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/095ff3670c5a1332ec6a6d251d8355c16a41627e)) ##### BREAKING CHANGES - Tests are not breaking, but as changing the fundamental parser, forcing major bump to be safe. Also updates: 1\. `require-description-complete-sentence` - test to fix output 2\. `require-hyphen-before-param-description` - test to preserve whitespace in fixed output (though still minus hyphen) 3\. `require-param` - test preserving whitespace 4 `require-jsdoc` - test with no indent ### [`v30.7.13`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v30.7.13) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v30.7.12...v30.7.13) ##### Bug Fixes - **`require-hyphen-before-param-description`:** regression failing to only check for hyphen at beginning; fixes [#665](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/665) ([acc3fc1](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/acc3fc1c577527ade66f2fa0f4001ea717bfb03a)) ### [`v30.7.12`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v30.7.12) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v30.7.11...v30.7.12) ##### Bug Fixes - **`require-jsdoc`:** skip past type annotations when seeking backward through decorators; fixes [#659](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/659) ([62abd11](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/62abd1102fc1b953106f03690766f5b84ccdf39b)) ### [`v30.7.11`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v30.7.11) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v30.7.10...v30.7.11) ##### Bug Fixes - **`no-bad-blocks`:** avoid erring with `/* */` comment ([4e6c73d](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/4e6c73d87204d0caf24fd210b352fb76172eb2ce)) ### [`v30.7.10`](https://togithub.com/gajus/eslint-plugin-jsdoc/releases/v30.7.10) [Compare Source](https://togithub.com/gajus/eslint-plugin-jsdoc/compare/v30.7.9...v30.7.10) ##### Bug Fixes - **`check-examples`:** disable `no-new` for `check-examples` and default param checking ([590d54e](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/590d54e4b4deed2963092da24e38dcb5a71a22f8)) - **`require-hyphen-before-param-description`:** allow whitespace before hyphen when checking for hyphens; fixes [#664](https://togithub.com/gajus/eslint-plugin-jsdoc/issues/664) ([fb906de](https://togithub.com/gajus/eslint-plugin-jsdoc/commit/fb906ded845afb73cbe0047a5ab4b0f7bb96b666))Renovate configuration
:date: Schedule: "before 3am on Monday,before 3am on Thursday" in timezone Europe/Stockholm.
:vertical_traffic_light: Automerge: Disabled by config. Please merge this manually once you are satisfied.
:recycle: Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
:no_bell: Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.