Skip to content
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.

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

chore(deps): update dependency eslint-plugin-jsdoc to v33 - autoclosed #867

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Apr 30, 2021

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
eslint-plugin-jsdoc 30.7.13 -> 33.3.0 age adoption passing confidence

Release Notes

gajus/eslint-plugin-jsdoc

v33.3.0

Compare Source

Features
  • check-line-alignment: allow tags option to apply with "always"; #​703 (4421e4e)

v33.2.0

Compare Source

Features

v33.1.1

Compare Source

Bug Fixes
  • update jsdoccomment to surface fixes (7de397b)

v33.1.0

Compare Source

Features
  • support comment-selector-based contexts (f73c72c)
  • support comment-selector-based contexts (6e835fd)

v33.0.0

Compare Source

chore
  • use external @es-joy/jsdoccomment for getJSDocComment functionality (aa77e3b)
BREAKING CHANGES
  • Should only be breaking for anyone requiring the getJSDocComment file.

Also updates Babel devDeps.

v32.3.4

Compare Source

Bug Fixes
  • preserve newlines in tag description comparisons; fixes #​692 (7edaed3)

v32.3.3

Compare Source

Bug Fixes
  • require-param, check-param-names: do not fail with destructured array pattern containing empty slots; fixes #​716 (f19e706)

v32.3.2

Compare Source

Bug Fixes
  • check-line-alignment: prevent false never reporting where a space is present (post tag) followed by missing space (from a wholly missing type) and then a space (but a space first preceded by content (a name); fixes #​714 (2c31db1)

v32.3.1

Compare Source

Bug Fixes
  • check-examples: disable chai-friendly/no-unused-expressions for default expression rules (06f0112)

v32.3.0

Compare Source

Features
  • check-tag-names: jsxTags an opt-in option for jsx annotations (8afb9fc)

v32.2.0

Compare Source

Features
  • check-types: check settings.jsdoc.structuredTags for an array of permissible types, reporting if not present; fixes #​695 (9dad3e0)
  • no-undefined-types: allow structuredTags types to be auto-defined (b7198e4)

v32.1.1

Compare Source

Bug Fixes
  • check-param-names, require-jsdoc, require-param: avoid erring upon MemberExpression or other constructions within dynamic properties; fixes #​699 (1cfdeb4)

v32.1.0

Compare Source

Features
  • require-jsdoc: allow checking for getter or setter only; fixes #​515 (937d65e)

v32.0.3

Compare Source

Bug Fixes
  • require-jsdoc: more accurate and optimized decorator detection; fixes #​697 (88655b3)

v32.0.2

Compare Source

Bug Fixes
  • match-description: while preserving internal newlines, ensure trailing whitespace is stripped for comparisons; for #​692 (27b95b3)

v32.0.1

Compare Source

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)

v32.0.0

Compare Source

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)
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

Compare Source

Bug Fixes

v31.6.0

Compare Source

Bug Fixes
  • require-returns, require-yields: support more AST checking (6fd8a07)
  • require-yields: avoid checking nested generators (as with functions) (b9058e4)
  • return-yields, return-yields-check: allow generator detection on exported; handle more AST types; fixes #​682 (4e768aa)
Features
  • require-returns-check: add exemptAsync option (0ed24c0)

v31.5.0

Compare Source

Bug Fixes
  • require-returns: check labeled statements (51f37f1)
  • require-throws: check labeled statements (ceadcfe)
  • require-yields: check test part of if expression and check conditionals (db001be)
  • require-yields: check labeled statements (aceb7a0)
Features
  • require-returns: if function returns a Promise whose executor resolves with undefined, avoid need to document unless forceReturnsWithAsync is set; fixes #​550 (565fdbd)

v31.4.0

Compare Source

Bug Fixes
  • check-line-alignment: escape user tag name in regex (c0ae4cb)
Features
  • check-line-alignment: allow tags option to configure which tags should be aligned. (780b8b5)

v31.3.3

Compare Source

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)

v31.3.2

Compare Source

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)
Reverts
  • Revert "optimize: ensure with new fix that we avoid checking back too far" (0fc4663)

v31.3.1

Compare Source

Bug Fixes
  • bug with false positive decorator detection (evident sans semi-colons); e.g., require-jsdoc fixer (6bda6b4)

v31.3.0

Compare Source

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)

v31.2.3

Compare Source

Bug Fixes
  • require-param, check-param-names: add option useDefaultObjectProperties for expecting documentation or avoiding reporting of documented; addresses part of #​676 (a36faf2)

v31.2.2

Compare Source

Bug Fixes
  • check-tag-names: should have previously auto-allowed settings.jsdoc.structuredTags tags (5f586fd)

v31.2.1

Compare Source

Bug Fixes
  • caps issue with require-yields-check rule (6b8d0d8)

v31.2.0

Compare Source

Features
  • require-yields-check: add rule to check that yield (of proper form) is present in the function body; fixes #​354 (acf9529)

v31.1.0

Compare Source

Features
  • require-yields: add new rule to check that yield has documentation; for #​354 (e06fddd)
  • require-yields: add options to check that next has documentation (15daa12)

v31.0.8

Compare Source

Bug Fixes
  • no-undefined-types: support true and false literals (b8cb394)

v31.0.7

Compare Source

Bug Fixes
  • ensure accurate parsing of names after multi-line types; fixes #​669 (7b9c1bd)

v31.0.6

Compare Source

Bug Fixes
  • update comment-parser to surface restoration of support for equal signs in defaults and multi-line types; fixes #​669; fixes #​673 (081d7eb)

v31.0.5

Compare Source

Bug Fixes
  • require-description-complete-sentence: regression re: not trimming of description for check as relevant to tag description checking; fixes #​672 (d81caa2)

v31.0.4

Compare Source

Bug Fixes
  • restore trim as relevant to tag description checking; fixes #​670 (9f69c36)

v31.0.3

Compare Source

Bug Fixes
  • newline-after-description: handle description on same line as opening asterisks; fixes #​668 (040d177)

v31.0.2

Compare Source

Bug Fixes
  • check-line-alignment: implement default never options; fixes #​483 (b2db226)

v31.0.1

Compare Source

Bug Fixes

v31.0.0

Compare Source

chore
  • update comment-parser; should now cause fixers to preserve original whitespace unless the rule is meant to fix it (095ff36)
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


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.

@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-33.x branch 3 times, most recently from 26b78ef to 0307fb2 Compare May 10, 2021 12:57
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-33.x branch from 0307fb2 to 17ab25f Compare May 10, 2021 15:00
@renovate renovate bot changed the title chore(deps): update dependency eslint-plugin-jsdoc to v33 chore(deps): update dependency eslint-plugin-jsdoc to v33 - autoclosed May 11, 2021
@renovate renovate bot closed this May 11, 2021
@renovate renovate bot deleted the renovate/eslint-plugin-jsdoc-33.x branch May 11, 2021 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants