Releases: gajus/eslint-plugin-jsdoc
Releases · gajus/eslint-plugin-jsdoc
v18.1.3
18.1.3 (2019-11-20)
Bug Fixes
newline-after-description
: only treat comments with whitespace after two asterisks only as jsdoc (3d61126)
v18.1.2
18.1.2 (2019-11-19)
Bug Fixes
newline-after-description
: avoid erring on encountering sequence of carriage returns (or other non-whitespace) as sole content of jsdoc block description (fixes #433) (e453b2d)
v18.1.1
18.1.1 (2019-11-19)
Bug Fixes
newline-after-description
: handle carriage returns properly: fixes #431 (a38b28b)
v18.1.0
18.1.0 (2019-11-19)
Features
check-values
: add licensePattern
option to allow delimiting portion of license description to extract (eed7dde)
v18.0.1
18.0.1 (2019-11-13)
Bug Fixes
check-values
: check for whole SPDX expression, not only single identifiers (e058efa)
v18.0.0
18.0.0 (2019-11-13)
Bug Fixes
check-param-names
: use ponyfill as such; avoid defining Object.entries
when not present (ea1a626)
Features
check-access
: add rule to check access levels (f919d5a)
empty-tags
: expect certain tags to be empty (66ebda9)
- check-values: add new rule for checking special tag values (within
version
, since
, license
, author
) (5543c29)
BREAKING CHANGES
- check-values: Adds to
recommended
.
@version
- Checks that there is a present and valid
semver version value.
@since
- As with @version
@license
- Checks that there is a present and valid SPDX identifier
or is present within an allowedLicenses
option.
@author
- Checks there is a value present, and if the option
allowedAuthors
is present, ensure that the author value is one
of these array items.
check-access
: New rule updates recommended
Checks @access
for allowed values and prohibits multiple access
modifier tags on the same block
empty-tags
: Added rule to recommended
.
May add additional tags to check for emptiness using tags
option.
v17.1.2
17.1.2 (2019-11-12)
Bug Fixes
no-undefined-types
: do not crash on variadic arguments (eaf41ed)
no-undefined-types
: properly parse template
tag name(s) for defined types (5f48821)
no-undefined-types
: surface jsdoctypeparser update to avoid errors with empty variadic argument; closes #419 (9124b7b)
v17.1.1
17.1.1 (2019-11-08)
Bug Fixes
require-description-complete-sentence
: allow pipe symbol at beginning/end of sentences; fixes #423 (0fb07c1)
v17.1.0
17.1.0 (2019-11-04)
Features
getJSDocComment
: ignore line comment (9d24b25)
v17.0.1
17.0.1 (2019-11-03)
Bug Fixes
check-tag-names
: ensure that the fenced block content of [@example](https://github.com/example)
tags are not treated as jsdoc tags; fixes #395 (bfa237b)