Skip to content

Releases: gajus/eslint-plugin-jsdoc

v25.1.0

11 May 05:49
Compare
Choose a tag to compare

25.1.0 (2020-05-11)

Features

  • require-jsdoc: support objects to contexts with a context and optional inlineCommentBlock property; fixes part of #530 (548bd59)

v25.0.1

09 May 07:02
Compare
Choose a tag to compare

25.0.1 (2020-05-09)

Bug Fixes

  • check-param-names, require-param: ignore TSIndexSignature; fixes #529 (3f76c7c)

v25.0.0

09 May 03:05
Compare
Choose a tag to compare

25.0.0 (2020-05-09)

Bug Fixes

  • require-param: allow checking for [@arg](https://github.com/arg) jsdoc param names if preferred (35088cb)

Features

  • check-param-names: checkRestProperty (and docs/tests) (7ce31e0)
  • check-param-names, require-param: check (and for require-param, fix) destructured objects and arrays, including the root. (a516865)
  • check-param-names, require-param: check (and for require-param, fix) destructured objects and arrays, including the root. (d906d1b)
  • require-param, check-param-names: checkTypesPattern (with docs, tests, and schema) (06add2f)

BREAKING CHANGES

  • check-param-names, require-param: Completes work on destructuring (prevents adding ...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 options unnamedRootBase, autoIncrementBase, checkRestProperty, enableFixer, enableRootFixer, enableRestElementFixer, checkTypesPattern

For check-param-names: Add options checkRestProperty and checkTypesPattern

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

06 May 15:04
Compare
Choose a tag to compare

24.0.6 (2020-05-06)

Bug Fixes

  • comment-detection logic issue with function expressions within function declarations (e7720ec)

v24.0.5

06 May 13:07
Compare
Choose a tag to compare

24.0.5 (2020-05-06)

Bug Fixes

  • avoid errors with getReducedASTNode; fixes #528 (be8d9a3)

v24.0.4

06 May 08:34
Compare
Choose a tag to compare

24.0.4 (2020-05-06)

Bug Fixes

  • in conjunction with comment-parser update, remove last line break in last tag description for proper stringification (and fix old tests) (fdf129b)

v24.0.3

06 May 02:06
Compare
Choose a tag to compare

24.0.3 (2020-05-06)

Bug Fixes

  • require-jsdoc: check above export for named exports; fixes #526 (757d97a)

v24.0.2

03 May 11:58
Compare
Choose a tag to compare

24.0.2 (2020-05-03)

Performance Improvements

  • only check moved settings if jsdoc settings exist (36ede65)

v24.0.1

03 May 00:42
Compare
Choose a tag to compare

24.0.1 (2020-05-03)

Bug Fixes

v24.0.0

20 Apr 08:46
Compare
Choose a tag to compare

24.0.0 (2020-04-20)

Bug Fixes

  • check-tag-names, empty-tags, require-description, require-example, require-param, require-returns: explicitly allow inheritDoc in all modes while only allowing inheritdoc in non-Closure mode; fixes #520 (48fc58b)

Features

  • add a global option for checking constructors, getters or setters and remove avoidExampleOnConstructors option. (e5236a2)

Reverts

  • Revert "fix(check-tag-names, empty-tags, require-description, require-example, require-param, require-returns) explicitly allow inheritDoc in all modes while only allowing inheritdoc in non-Closure mode; fixes #520" (d97c8f0), closes #520

BREAKING CHANGES

  • Replaces the option avoidExampleOnConstructors for
    the require-example rule by checkConstructors

Also makes build-call platform independent and ensures env-variables work an all platforms.