chore(deps): update dependency eslint-plugin-jsdoc to v25 - autoclosed #436
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:
18.11.0
->25.4.3
Release Notes
gajus/eslint-plugin-jsdoc
v25.4.3
Compare Source
Bug Fixes
ArrowFunctionExpression
potentially reported when part ofAssignmentExpression
; fixes #551 (d8c4e87)v25.4.2
Compare Source
Bug Fixes
async
withreturn
should be documented; fixes #518 (99476af)v25.4.1
Compare Source
Bug Fixes
tagNamePreference
; fixes #537 (ed0fa4e)v25.4.0
Compare Source
Features
checkDestructured
option; fixes #530 (4df57a8)v25.3.1
Compare Source
Bug Fixes
MethodDefinition
(including withany
) is the context; fixes #534 (1a69565)MethodDefinition
context (82fb8c9)v25.3.0
Compare Source
Features
enableFixer
option (3d5ee0c)v25.2.1
Compare Source
Bug Fixes
ExperimentalRestProperty
frombabel-eslint
as withRestElement
; fixes #536 (d330391)v25.2.0
Compare Source
Features
Promise<void>
andPromise<undefined>
(d855301)v25.1.0
Compare Source
Features
contexts
with acontext
and optionalinlineCommentBlock
property; fixes part of #530 (548bd59)v25.0.1
Compare Source
Bug Fixes
TSIndexSignature
; fixes #529 (3f76c7c)v25.0.0
Compare Source
Bug Fixes
[@arg](https://togithub.com/arg)
jsdoc param names if preferred (35088cb)Features
checkRestProperty
(and docs/tests) (7ce31e0)checkTypesPattern
(with docs, tests, and schema) (06add2f)BREAKING CHANGES
...any
for rest properties).Works with renamed parameters and defaults and has special handling for rest elements/properties and type annotations.
For
require-param
: Adds optionsunnamedRootBase
,autoIncrementBase
,checkRestProperty
,enableFixer
,enableRootFixer
,enableRestElementFixer
,checkTypesPattern
For
check-param-names
: Add optionscheckRestProperty
andcheckTypesPattern
Also ensures indent is relative to applicable node, not whole source code; fix indents in tests
For testing, add
output
and cover more cases.v24.0.6
Compare Source
Bug Fixes
v24.0.5
Compare Source
Bug Fixes
getReducedASTNode
; fixes #528 (be8d9a3)v24.0.4
Compare Source
Bug Fixes
comment-parser
update, remove last line break in last tag description for proper stringification (and fix old tests) (fdf129b)v24.0.3
Compare Source
Bug Fixes
v24.0.2
Compare Source
Performance Improvements
v24.0.1
Compare Source
Bug Fixes
v24.0.0
Compare Source
Bug Fixes
inheritDoc
in all modes while only allowinginheritdoc
in non-Closure mode; fixes #520 (48fc58b)Features
avoidExampleOnConstructors
option. (e5236a2)Reverts
inheritDoc
in all modes while only allowinginheritdoc
in non-Closure mode; fixes #520" (d97c8f0), closes #520BREAKING CHANGES
avoidExampleOnConstructors
forthe
require-example
rule bycheckConstructors
Also makes build-call platform independent and ensures env-variables work an all platforms.
v23.1.0
Compare Source
Features
v23.0.1
Compare Source
Bug Fixes
MethodDefinition
withpublicOnly
ESM export; fixes #519 (dfde551)v23.0.0
Compare Source
Features
require-description
,require-example
,require-param
,require-returns
: causeexemptedBy
to overwriteinheritdoc
exempting; closes #510 (a402330)BREAKING CHANGES
require-description
,require-example
,require-param
,require-returns
: While still defaulting to havinginheritdoc
exempt rules, for the impacted rules,if one has defined an
exemptedBy
options array one must now explicitly addback
"inheritdoc"
to get the exemption for that tag as well. This change allowsusers to omit
inheritdoc
from the array so as to cause its presence not totrigger exemption of the rule.
v22.2.0
Compare Source
Features
require-param
: addcontexts
option; closes #511 (3aaba73)v22.1.0
Compare Source
Features
require-returns
: addcheckGetter
option to be able to disable enforcement on getters (eb3cc84)v22.0.1
Compare Source
Bug Fixes
require-jsdoc
: ensureexemptEmptyFunctions
doesn't attempt to apply when non-function contexts are in use (causing errors); fixes #501 (7daf934)v22.0.0
Compare Source
BREAKING CHANGES
v21.0.0
Compare Source
Bug Fixes
check-param-names
,check-property-names
,require-file-overview
: avoid direct use of uncertain license ofobject.entries-ponyfill
; closes #487 (4403fb0)BREAKING CHANGES
check-param-names
,check-property-names
,require-file-overview
: Now requires Node >= 8v20.4.0
Compare Source
Features
require-returns-check
: Allow @return to be omitted with @record tag in Closure mode (20b6ae0)v20.3.1
Compare Source
Bug Fixes
check-values
: allow[@version](https://togithub.com/version)
and[@since](https://togithub.com/since)
to have versions surrounded by whitespace (37466a8)v20.3.0
Compare Source
Features
no-bad-blocks
: add rule to check for multi-line-style comments which fail to meet criteria of a jsdoc block (4ce07d1)v20.2.0
Compare Source
Features
no-defaults
: add new rule to reports defaults on[@param](https://togithub.com/param)
or[@default](https://togithub.com/default)
and optionally report optional args; fixes #477 (d7fec9a)v20.1.0
Compare Source
Features
require-hyphen-before-param-description
: add option to support checkingproperty
/prop
(1383c02)v20.0.5
Compare Source
Performance Improvements
check-examples
: avoid caching unused config (6cbf286)v20.0.4
Compare Source
Bug Fixes
no-types
,require-param
:fixable
meta should becode
nottrue
(b0aed65)require-file-overview
: omitfixable
meta on non-fixable rule (efddc1c)v20.0.3
Compare Source
Bug Fixes
check-property-names
: check duplicate nested names (1c31782)v20.0.2
Compare Source
Bug Fixes
check-param-names
: check duplicate nested names; fixes #474 (c51d616)v20.0.1
Compare Source
Bug Fixes
require-jsdoc
: handle spread elements in typescript-eslint/parser; for #378 (3e8ea59)v20.0.0
Compare Source
Features
check-examples
: apply rules by default as if on current JavaScript file (though withmd
extension for easier automated overriding); fixes #434 (976cfc1)refactoring
check-examples
: renameeslintrcForExamples
tocheckEslintrc
; also ensurematchingFileName
always triggers config retrieval (5a85f0f)BREAKING CHANGES
check-examples
: This commit also clarifies new precedence and behavior in docs.v19.2.0
Compare Source
Features
require-file-overview
: allow user to specify whether checking for tag, duplicates, or preceding non-comments, and for which tags (f6e467e)v19.1.0
Compare Source
Features
no-types
,implements-on-classes
: addcontexts
option which if set toany
will allow checking of virtual functions (c4079b8)require-param-*
,require-returns-*
,require-returns
: allowscontexts
option to be set to "any" to check virtual function docs like[@callback](https://togithub.com/callback)
or[@function](https://togithub.com/function)
with[@interface](https://togithub.com/interface)
; fixes #406 (7500b00)v19.0.1
Compare Source
Bug Fixes
require-file-overview
: fix logic for detecting start of file (601e52d)v19.0.0
Compare Source
Features
check-property-names
: add rule to check for duplicated and improperly nested properties (492b814)require-property*: add rules for ensuring property tags have a name, type, and/or description (in any context); fixes #409 (e5f2a23)
feat(
require-property
); add rule to check forproperty
ontypedef
ornamespace
where the type isobject
; fixes #410 (68bf6cd), closes #410BREAKING CHANGES
check-property-names
: Adds new rule torecommended
recommended
recommended
config.Renovate 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.
This PR has been generated by WhiteSource Renovate. View repository job log here.