chore(deps): update dependency eslint-plugin-jsdoc to v34 - autoclosed #880
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
30.7.13
->34.8.2
Release Notes
gajus/eslint-plugin-jsdoc
v34.8.2
Compare Source
Bug Fixes
check-line-alignment
: add multiline type workaround (#744); fixes part of #743 (9928298)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
: addtags
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
: addnoFinalLineText
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
: ensurenoZeroLineText
checks whennoMultilineBlocks
istrue
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
tag-line
; fixes #93 (851e3fe)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 missingcomment
(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
: addpreventAllMultiasteriskBlocks
boolean option to allow reporting of any multi-asterisked multiline comments (9669fc3)v34.1.0
Compare Source
Features
check-line-alignment
: addpreserveMainDescriptionPostDelimiter
option to preserve left-hand side spacings in the main description when using thealways
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
v34.0.0
Compare Source
chore
BREAKING CHANGES
flat
APIv33.3.0
Compare Source
Features
check-line-alignment
: allowtags
option to apply with "always"; #703 (4421e4e)v33.2.0
Compare Source
Features
v33.1.1
Compare Source
Bug Fixes
v33.1.0
Compare Source
Features
v33.0.0
Compare Source
chore
@es-joy/jsdoccomment
forgetJSDocComment
functionality (aa77e3b)BREAKING CHANGES
getJSDocComment
file.Also updates Babel devDeps.
v32.3.4
Compare Source
Bug Fixes
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
: checksettings.jsdoc.structuredTags
for an array of permissible types, reporting if not present; fixes #695 (9dad3e0)no-undefined-types
: allowstructuredTags
types to be auto-defined (b7198e4)v32.1.1
Compare Source
Bug Fixes
check-param-names
,require-jsdoc
,require-param
: avoid erring uponMemberExpression
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
u
flag forcheckTypesPattern
option forrequire-param
,check-param-names
; forcheck-values
, default tou
flag and allow slashed regexes with own flags; formatch-description
, allow slashed regexs with own flags; for all of the previous (andcheck-examples
) allows newlines (4f0dc8e)v32.0.0
Compare Source
Bug Fixes
[@example](https://togithub.com/example)
frommd
tomd/*.js
. Only applies whenmatchingFileName
is not used. (2cc1227)BREAKING CHANGES
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 sameoverrides
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 bycheck-examples
to simulate an expression which will now be a suitable choice foroverrides
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 thematchingFileName
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
comment-parser
; fixes #686 (7e0bbbe)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
: addexemptAsync
option (0ed24c0)v31.5.0
Compare Source
Bug Fixes
require-returns
: check labeled statements (51f37f1)require-throws
: check labeled statements (ceadcfe)require-yields
: checktest
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 unlessforceReturnsWithAsync
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
: allowtags
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 withreturns
/return
as well as handle missing type (cb39556)v31.3.2
Compare Source
Bug Fixes
Reverts
v31.3.1
Compare Source
Bug Fixes
require-jsdoc
fixer (6bda6b4)v31.3.0
Compare Source
Features
check-param-names
: add optionsdisableExtraPropertyReporting
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 optionuseDefaultObjectProperties
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-allowedsettings.jsdoc.structuredTags
tags (5f586fd)v31.2.1
Compare Source
Bug Fixes
v31.2.0
Compare Source
Features
require-yields-check
: add rule to check thatyield
(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 thatyield
has documentation; for #354 (e06fddd)require-yields
: add options to check thatnext
has documentation (15daa12)v31.0.8
Compare Source
Bug Fixes
no-undefined-types
: supporttrue
andfalse
literals (b8cb394)v31.0.7
Compare Source
Bug Fixes
v31.0.6
Compare Source
Bug Fixes
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
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 defaultnever
options; fixes #483 (b2db226)v31.0.1
Compare Source
Bug Fixes
check-line-alignment
: handle spaces in type and skip for single line (@renatho); closes #638 (577863b)v31.0.0
Compare Source
chore
BREAKING CHANGES
Also updates:
require-description-complete-sentence
- test to fix outputrequire-hyphen-before-param-description
- test to preserve whitespace in fixed output (though still minus hyphen)require-param
- test preserving whitespace4
require-jsdoc
- test with no indentConfiguration
📅 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.
This PR has been generated by WhiteSource Renovate. View repository job log here.