Skip to content

Commit 2ec8b3e

Browse files
Merge #270
270: Bump eslint-plugin-jsdoc from 30.7.13 to 32.0.0 r=curquiza a=dependabot-preview[bot] Bumps [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) from 30.7.13 to 32.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/gajus/eslint-plugin-jsdoc/releases">eslint-plugin-jsdoc's releases</a>.</em></p> <blockquote> <h2>v32.0.0</h2> <h1><a href="https://github.com/gajus/eslint-plugin-jsdoc/compare/v31.6.1...v32.0.0">32.0.0</a> (2021-02-15)</h1> <h3>Bug Fixes</h3> <ul> <li><strong>check-examples:</strong> change default extension for simulated file name of <code>[@example](https://github.com/example)</code> from <code>md</code> to <code>md/*.js</code>. Only applies when <code>matchingFileName</code> is not used. (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/2cc12279f35f0136e6b3a68c7d19ae8719e7a061">2cc1227</a>)</li> </ul> <h3>BREAKING CHANGES</h3> <ul> <li><strong>check-examples:</strong> Per update to <code>eslint-plugin-markdown</code> 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 <code>overrides</code> config to be reusable between Markdown fenced blocks and <code>@example</code> 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 <code>@example</code> tags by <code>check-examples</code> to simulate an expression which will now be a suitable choice for <code>overrides</code> in targeting Markdown fenced blocks using the new parser API, as with eslint-plugin-markdown@2 (i.e., &quot;md/*.js&quot; instead of &quot;md&quot;).</li> </ul> <p>If you need to use ESLint 6 (or eslint-plugin-markdown &lt; 2, for example) with <code>check-examples</code>, you should be able to manually supply the <code>matchingFileName</code> option targeting &quot;md&quot;, e.g., set to <code>'dummy.md</code>.</p> <p>This commit also simplifies a testing example to avoid it throwing with changed config not having proper babel support (not meaningful to test anyways)</p> <h2>v31.6.1</h2> <h2><a href="https://github.com/gajus/eslint-plugin-jsdoc/compare/v31.6.0...v31.6.1">31.6.1</a> (2021-02-07)</h2> <h3>Bug Fixes</h3> <ul> <li>update <code>comment-parser</code>; fixes <a href="https://github-redirect.dependabot.com/gajus/eslint-plugin-jsdoc/issues/686">#686</a> (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/7e0bbbe82eb4a1d0b0c603ed0c78bd6e685dee20">7e0bbbe</a>)</li> </ul> <h2>v31.6.0</h2> <h1><a href="https://github.com/gajus/eslint-plugin-jsdoc/compare/v31.5.0...v31.6.0">31.6.0</a> (2021-01-31)</h1> <h3>Bug Fixes</h3> <ul> <li><strong><code>require-returns</code>, <code>require-yields</code>:</strong> support more AST checking (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/6fd8a070c12a30eec8ccca5486446a06331a3d45">6fd8a07</a>)</li> <li><strong><code>require-yields</code>:</strong> avoid checking nested generators (as with functions) (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/b9058e493640289e4a585e48a2dad810f0c170a4">b9058e4</a>)</li> <li><strong><code>return-yields</code>, <code>return-yields-check</code>:</strong> allow generator detection on exported; handle more AST types; fixes <a href="https://github-redirect.dependabot.com/gajus/eslint-plugin-jsdoc/issues/682">#682</a> (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/4e768aaed4c9fd28496af910e147183a950ce6a1">4e768aa</a>)</li> </ul> <h3>Features</h3> <ul> <li><strong><code>require-returns-check</code>:</strong> add <code>exemptAsync</code> option (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/0ed24c049919757c15ec80e06e4be8686524c47b">0ed24c0</a>)</li> </ul> <h2>v31.5.0</h2> <h1><a href="https://github.com/gajus/eslint-plugin-jsdoc/compare/v31.4.0...v31.5.0">31.5.0</a> (2021-01-31)</h1> <h3>Bug Fixes</h3> <ul> <li><strong><code>require-returns</code>:</strong> check labeled statements (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/51f37f10774ff3d9cd33faecdf829e83610700c5">51f37f1</a>)</li> <li><strong><code>require-throws</code>:</strong> check labeled statements (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/ceadcfe7fed67af579fb2de6fb0df8aefe37a115">ceadcfe</a>)</li> <li><strong><code>require-yields</code>:</strong> check <code>test</code> part of if expression and check conditionals (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/db001bebad9ef1b5a27297142fd328cbcc86759f">db001be</a>)</li> <li><strong><code>require-yields</code>:</strong> check labeled statements (<a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/aceb7a096fadc13939163ec1b77b03e771002477">aceb7a0</a>)</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/2cc12279f35f0136e6b3a68c7d19ae8719e7a061"><code>2cc1227</code></a> fix(check-examples): change default extension for simulated file name of `@ex...</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/bc391f33552418080bbb03dfabeee4345cd05fd6"><code>bc391f3</code></a> chore: update devDep. (gitdown)</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/aefc1c1058768c93994ffbaae1d05bce07f2e93d"><code>aefc1c1</code></a> chore: update eslint devDep and semantic-release; resume using <code>:has()</code> selec...</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/547a1c95d3a7094d9c4ed9b8550c1a2551f7d76b"><code>547a1c9</code></a> docs: clarify comment on options structure</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/08e76b12f67b1b83354f1f6c86a65a4a963286ef"><code>08e76b1</code></a> chore: update devDeps (besides husky which is temporarily changing its licens...</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/b42bf7974dd34a799f67ed658c51216209e9f418"><code>b42bf79</code></a> docs: create separate template for documentation bugs</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/ae0112ca9eeaac5d43c8b70a3ff0afe727588650"><code>ae0112c</code></a> docs: clarify that not all rules expect a single object option; fix a few rul...</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/9f757aa3e43c084f1cc3a609317dd90af6156320"><code>9f757aa</code></a> refactor(<code>check-line-alignment</code>): drop redundant replacements per `comment-pa...</li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/7e0bbbe82eb4a1d0b0c603ed0c78bd6e685dee20"><code>7e0bbbe</code></a> fix: update <code>comment-parser</code>; fixes <a href="https://github-redirect.dependabot.com/gajus/eslint-plugin-jsdoc/issues/686">#686</a></li> <li><a href="https://github.com/gajus/eslint-plugin-jsdoc/commit/bd24a7e19c76c22c5fc0abd4bcae8718c6b574fd"><code>bd24a7e</code></a> chore: update devDeps.</li> <li>Additional commits viewable in <a href="https://github.com/gajus/eslint-plugin-jsdoc/compare/v30.7.13...v32.0.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=eslint-plugin-jsdoc&package-manager=npm_and_yarn&previous-version=30.7.13&new-version=32.0.0)](https://dependabot.com/compatibility-score/?dependency-name=eslint-plugin-jsdoc&package-manager=npm_and_yarn&previous-version=30.7.13&new-version=32.0.0) You can trigger a rebase of this PR by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com): - Update frequency (including time of day and day of week) - Pull request limits (per update run and/or open at any time) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired) </details> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2 parents 88944ed + 05d0570 commit 2ec8b3e

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
"eslint-plugin-flowtype": "^5.2.0",
8282
"eslint-plugin-import": "^2.22.0",
8383
"eslint-plugin-jest": "^24.0.0",
84-
"eslint-plugin-jsdoc": "^30.7.7",
84+
"eslint-plugin-jsdoc": "^32.0.0",
8585
"eslint-plugin-jsx-a11y": "^6.4.1",
8686
"eslint-plugin-node": "^11.1.0",
8787
"eslint-plugin-prettier": "^3.1.4",

yarn.lock

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2349,10 +2349,10 @@ commander@^4.0.1:
23492349
resolved "https://registry.yarnpkg.com/commander/-/commander-4.1.1.tgz#9fd602bd936294e9e9ef46a3f4d6964044b18068"
23502350
integrity sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==
23512351

2352-
comment-parser@^0.7.6:
2353-
version "0.7.6"
2354-
resolved "https://registry.yarnpkg.com/comment-parser/-/comment-parser-0.7.6.tgz#0e743a53c8e646c899a1323db31f6cd337b10f12"
2355-
integrity sha512-GKNxVA7/iuTnAqGADlTWX4tkhzxZKXp5fLJqKTlQLHkE65XDUKutZ3BHaJC5IGcper2tT3QRD1xr4o3jNpgXXg==
2352+
comment-parser@1.1.2:
2353+
version "1.1.2"
2354+
resolved "https://registry.yarnpkg.com/comment-parser/-/comment-parser-1.1.2.tgz#e5317d7a2ec22b470dcb54a29b25426c30bf39d8"
2355+
integrity sha512-AOdq0i8ghZudnYv8RUnHrhTgafUGs61Rdz9jemU5x2lnZwAWyOq7vySo626K59e1fVKH1xSRorJwPVRLSWOoAQ==
23562356

23572357
commondir@^1.0.1:
23582358
version "1.0.1"
@@ -2978,12 +2978,12 @@ eslint-plugin-jest@^24.0.0:
29782978
dependencies:
29792979
"@typescript-eslint/experimental-utils" "^4.0.1"
29802980

2981-
eslint-plugin-jsdoc@^30.7.7:
2982-
version "30.7.13"
2983-
resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-30.7.13.tgz#52e5c74fb806d3bbeb51d04a0c829508c3c6b563"
2984-
integrity sha512-YM4WIsmurrp0rHX6XiXQppqKB8Ne5ATiZLJe2+/fkp9l9ExXFr43BbAbjZaVrpCT+tuPYOZ8k1MICARHnURUNQ==
2981+
eslint-plugin-jsdoc@^32.0.0:
2982+
version "32.0.0"
2983+
resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-32.0.0.tgz#3e7b0dd452232845e9311442607c07c8787b933a"
2984+
integrity sha512-AfGe3gqJlcxyRKUjhLzPTUnEMlVVlWJCAh2N0leJndpMflyh0W7zP09+b6NQHBHk7GyR/JY0bXiSswN3QX9Lhg==
29852985
dependencies:
2986-
comment-parser "^0.7.6"
2986+
comment-parser "1.1.2"
29872987
debug "^4.3.1"
29882988
jsdoctypeparser "^9.0.0"
29892989
lodash "^4.17.20"

0 commit comments

Comments
 (0)