eslint-plugin-jsdoc

JSDoc specific linting rules for ESLint.

OTHER License

Downloads
9.7M
Stars
1.1K
Committers
104

Bot releases are hidden (Show)

eslint-plugin-jsdoc - v25.3.1

Published by gajus over 4 years ago

25.3.1 (2020-05-12)

Bug Fixes

  • check-param-name, check-property-names, empty-tags, no-defaults, no-types, require-property: avoid mangled indent with fixers, e.g., on class methods (8d5d837)
  • require-description, implements-on-classes: fix constructor detection if MethodDefinition (including with any) is the context; fixes #534 (1a69565)
  • require-returns, implements-on-classes, no-types: fix iterating function detection to include an explicit MethodDefinition context (82fb8c9)
eslint-plugin-jsdoc - v25.3.0

Published by gajus over 4 years ago

25.3.0 (2020-05-12)

Features

  • check-param-names, check-property-names: add enableFixer option (3d5ee0c)
eslint-plugin-jsdoc - v25.2.1

Published by gajus over 4 years ago

25.2.1 (2020-05-12)

Bug Fixes

  • check-param-names, require-param: check ExperimentalRestProperty from babel-eslint as with RestElement; fixes #536 (d330391)
eslint-plugin-jsdoc - v25.2.0

Published by gajus over 4 years ago

25.2.0 (2020-05-11)

Features

  • require-returns-description: avoid reporting missing descroptions for Promise<void> and Promise<undefined> (d855301)
eslint-plugin-jsdoc - v25.1.0

Published by gajus over 4 years ago

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)
eslint-plugin-jsdoc - v25.0.1

Published by gajus over 4 years ago

25.0.1 (2020-05-09)

Bug Fixes

  • check-param-names, require-param: ignore TSIndexSignature; fixes #529 (3f76c7c)
eslint-plugin-jsdoc - v25.0.0

Published by gajus over 4 years ago

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.

eslint-plugin-jsdoc - v24.0.6

Published by gajus over 4 years ago

24.0.6 (2020-05-06)

Bug Fixes

  • comment-detection logic issue with function expressions within function declarations (e7720ec)
eslint-plugin-jsdoc - v24.0.5

Published by gajus over 4 years ago

24.0.5 (2020-05-06)

Bug Fixes

  • avoid errors with getReducedASTNode; fixes #528 (be8d9a3)
eslint-plugin-jsdoc - v24.0.4

Published by gajus over 4 years ago

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)
eslint-plugin-jsdoc - v24.0.3

Published by gajus over 4 years ago

24.0.3 (2020-05-06)

Bug Fixes

  • require-jsdoc: check above export for named exports; fixes #526 (757d97a)
eslint-plugin-jsdoc - v24.0.2

Published by gajus over 4 years ago

24.0.2 (2020-05-03)

Performance Improvements

  • only check moved settings if jsdoc settings exist (36ede65)
eslint-plugin-jsdoc - v24.0.1

Published by gajus over 4 years ago

24.0.1 (2020-05-03)

Bug Fixes

eslint-plugin-jsdoc - v24.0.0

Published by gajus over 4 years ago

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.

eslint-plugin-jsdoc - v23.1.0

Published by gajus over 4 years ago

23.1.0 (2020-04-20)

Features

  • require-param: further support for typescript functions; closes #512 (fe637d5)
eslint-plugin-jsdoc - v23.0.1

Published by gajus over 4 years ago

23.0.1 (2020-04-19)

Bug Fixes

  • require-jsdoc: allow requiring of MethodDefinition with publicOnly ESM export; fixes #519 (dfde551)
eslint-plugin-jsdoc - v23.0.0

Published by gajus over 4 years ago

23.0.0 (2020-04-11)

Features

  • require-description, require-example, require-param, require-returns: cause exemptedBy to overwrite inheritdoc exempting; closes #510 (a402330)

BREAKING CHANGES

  • require-description, require-example, require-param, require-returns: While still defaulting to having inheritdoc exempt rules, for the impacted rules,
    if one has defined an exemptedBy options array one must now explicitly add
    back "inheritdoc" to get the exemption for that tag as well. This change allows
    users to omit inheritdoc from the array so as to cause its presence not to
    trigger exemption of the rule.
eslint-plugin-jsdoc - v22.2.0

Published by gajus over 4 years ago

22.2.0 (2020-04-11)

Features

  • require-param: add contexts option; closes #511 (3aaba73)
eslint-plugin-jsdoc - v22.1.0

Published by gajus over 4 years ago

22.1.0 (2020-03-18)

Features

  • require-returns: add checkGetter option to be able to disable enforcement on getters (eb3cc84)
eslint-plugin-jsdoc - v22.0.1

Published by gajus over 4 years ago

22.0.1 (2020-03-12)

Bug Fixes

  • require-jsdoc: ensure exemptEmptyFunctions doesn't attempt to apply when non-function contexts are in use (causing errors); fixes #501 (7daf934)
Package Rankings
Top 0.88% on Npmjs.org
Top 6.73% on Proxy.golang.org
Badges
Extracted from project README
NPM version Travis build status js-canonical-style Discord Chat