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 v35 - autoclosed #511

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented May 24, 2021

WhiteSource Renovate

This PR contains the following updates:

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

Release Notes

gajus/eslint-plugin-jsdoc

v35.5.1

Compare Source

Bug Fixes

v35.5.0

Compare Source

Features
  • require-returns-check: add exemptGenerators option (default on for typescript mode) to allow [@returns](https://togithub.com/returns) to be present even without return (8ef41a1)

v35.4.7

Compare Source

Bug Fixes
  • require-returns: handle contexts TSFunctionType, TSMethodSignature, MethodDefinition; fixes #​767 (fdca227)

v35.4.6

Compare Source

Bug Fixes
  • require-param: if adding params, convert single-line block to multiline; fixes #​771 (641cdee)

v35.4.5

Compare Source

Bug Fixes
  • valid-types: allow and require types on [@extends](https://togithub.com/extends) for TypeScript as used in docs (and not name) (6989699)

v35.4.4

Compare Source

Bug Fixes
  • tag-lines: allow any in tags[tag].lines option to allow lines per tag when otherwise blocked (52d7eff)

v35.4.3

Compare Source

Bug Fixes
  • check-line-alignment: preserve carriage returns; fixes #​745 (27521d2)

v35.4.2

Compare Source

Bug Fixes
  • check-examples: auto-disable no-empty-function rule for expression checking; clear it is a no-op in this context (5a928db)

v35.4.1

Compare Source

Bug Fixes

v35.4.0

Compare Source

Features

v35.3.2

Compare Source

Bug Fixes
  • stop reporting for async functions with throw missing [@throws](https://togithub.com/throws); fixes #​722 (f7c8038)

v35.3.1

Compare Source

Bug Fixes
  • valid-types: parse name paths as permissive. (657c67c)

v35.3.0

Compare Source

Features

v35.2.0

Compare Source

Features
  • no-missing-syntax, no-restricted-syntax, etc.: assume any context if context omitted (2dcd9ad)

v35.1.3

Compare Source

Bug Fixes
  • require-jsdoc: exemptEmptyFunctions option could trigger problematic return value checking behavior with no-argument functions (3089a92)

v35.1.2

Compare Source

Bug Fixes
  • update jsdoc-type-pratt-parser (1745fca)

v35.1.1

Compare Source

Bug Fixes
  • update jsdoc-type-pratt-parser (liberalizes ID start to support underscores and start/continue to support other Unicode) (1a6de5e)

v35.1.0

Compare Source

Bug Fixes
  • no-missing-syntax, no-restricted-syntax: support "any" with comment including global comments (dc641cc)
Features
  • use jsdoc-type-pratt-parser (647d47e)

v35.0.0

Compare Source

Bug Fixes
  • multiline-blocks: Enable (noZeroLineText and noFinalLineText will apply by default) (b81e25d)
BREAKING CHANGES
  • multiline-blocks: Should have been enabled by default

Also adds newer rules to doc listing

v34.8.2

Compare Source

Bug Fixes

v34.8.1

Compare Source

Bug Fixes
  • tag-lines: avoid false positive for "never" when line break occurs in the middle of a tag description. (3496011)
  • tag-lines: ensure a middle-of-block empty line doesn't suppress "always" errors (33aa921)

v34.8.0

Compare Source

Features
  • tag-lines: add tags option to override behavior on a tag-specific basis (including only applying to tag(s)); fixes #​734 (6e5e76d)

v34.7.0

Compare Source

Features
  • multiline-blocks: add noFinalLineText option; fixes #​738 (03d3f40)

v34.6.3

Compare Source

Bug Fixes
  • multiline-blocks: fix merging of lines to prevent removal of spaces, though removing where needed (9af6e36)

v34.6.2

Compare Source

Bug Fixes
  • multiline-blocks: ensure noZeroLineText checks when noMultilineBlocks is true but not matching; fixes #​737 (19f60ac)

v34.6.1

Compare Source

Bug Fixes
  • no-multi-asterisks: avoid false positives and erring in fixer of single line blocks; fixes #​735 (355da58)

v34.6.0

Compare Source

Features
  • no-multi-asterisks rule to prevent multiple asterisks with middle delimiters or at end of blocks (8848246)

v34.5.0

Compare Source

Features
  • multiline-blocks: allow control of how and whether jsdoc blocks can be expressed as single or multiple line blocks (06bbf37)

v34.4.0

Compare Source

Features

v34.3.0

Compare Source

Features
  • check-values: ensure [@variation](https://togithub.com/variation) is a positive integer (56577ce)

v34.2.2

Compare Source

Bug Fixes
  • check-param-names: adjusts line numbers to be nearer problematic item (e6c9ab2)
  • no-missing-syntax: pass in missing comment (a977896)

v34.2.1

Compare Source

Bug Fixes
  • require-description, require-example: for missing description, use tag line number (310ea75)

v34.2.0

Compare Source

Features
  • no-bad-blocks: add preventAllMultiasteriskBlocks boolean option to allow reporting of any multi-asterisked multiline comments (9669fc3)

v34.1.0

Compare Source

Features
  • check-line-alignment: add preserveMainDescriptionPostDelimiter option to preserve left-hand side spacings in the main description when using the always option. (54dac34)

v34.0.2

Compare Source

Bug Fixes
  • no-bad-blocks: avoid allowing 3+ asterisks with tag content (as with only 1 asterisk) (28397c7)

v34.0.1

Compare Source

Bug Fixes
  • multiline tag fixers omitting subsequent tag lines with new command-parser API (8fa7f9b)

v34.0.0

Compare Source

chore
BREAKING CHANGES
  • Also:
  • Build: Switch to Node 12 target
  • Linting: Use flat API
  • Travis: Add Node 16, remove Node 10
  • npm: Update devDep.

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.

@commit-lint
Copy link

commit-lint bot commented May 24, 2021

Chore

  • deps: update dependency eslint-plugin-jsdoc to v35 (6eba3a9)

Contributors

renovate-bot

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR:

  • @Commit-Lint merge patch will merge dependabot PR on "patch" versions (X.X.Y - Y change)
  • @Commit-Lint merge minor will merge dependabot PR on "minor" versions (X.Y.Y - Y change)
  • @Commit-Lint merge major will merge dependabot PR on "major" versions (Y.Y.Y - Y change)
  • @Commit-Lint merge disable will desactivate merge dependabot PR
  • @Commit-Lint review will approve dependabot PR
  • @Commit-Lint stop review will stop approve dependabot PR

@coveralls
Copy link

coveralls commented May 24, 2021

Coverage Status

Coverage remained the same at 88.889% when pulling 71d1d04 on renovate/eslint-plugin-jsdoc-35.x into 981244d on master.

@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-35.x branch 4 times, most recently from 5825779 to d1c7d3e Compare June 6, 2021 11:36
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-35.x branch 4 times, most recently from 90532a6 to 467d608 Compare June 19, 2021 06:37
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-35.x branch from 467d608 to 089c91b Compare June 21, 2021 12:34
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-35.x branch from 089c91b to 7aced17 Compare June 29, 2021 02:13
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-35.x branch 2 times, most recently from d68908f to 3662f7c Compare July 10, 2021 00:10
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-35.x branch 5 times, most recently from 21a6f5b to e2e2a07 Compare July 20, 2021 09:13
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-35.x branch from e2e2a07 to 6eba3a9 Compare July 22, 2021 08:53
@renovate renovate bot changed the title chore(deps): update dependency eslint-plugin-jsdoc to v35 chore(deps): update dependency eslint-plugin-jsdoc to v35 - autoclosed Jul 25, 2021
@renovate renovate bot closed this Jul 25, 2021
@renovate renovate bot deleted the renovate/eslint-plugin-jsdoc-35.x branch July 25, 2021 03:25
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

2 participants