eslint-plugin-jsdoc

JSDoc specific linting rules for ESLint.

OTHER License

Downloads
9.7M
Stars
1.1K
Committers
104

Bot releases are visible (Hide)

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)
eslint-plugin-jsdoc - v22.0.0

Published by gajus over 4 years ago

22.0.0 (2020-03-01)

BREAKING CHANGES

  • Drops ESLint@5 support
eslint-plugin-jsdoc - v21.0.0

Published by gajus over 4 years ago

21.0.0 (2020-01-25)

Bug Fixes

  • check-param-names, check-property-names, require-file-overview: avoid direct use of uncertain license of object.entries-ponyfill; closes #487 (4403fb0)

BREAKING CHANGES

  • check-param-names, check-property-names, require-file-overview: Now requires Node >= 8
eslint-plugin-jsdoc - v20.4.0

Published by gajus over 4 years ago

20.4.0 (2020-01-23)

Features

eslint-plugin-jsdoc - v20.3.1

Published by gajus almost 5 years ago

20.3.1 (2020-01-15)

Bug Fixes

  • check-values: allow [@version](https://github.com/version) and [@since](https://github.com/since) to have versions surrounded by whitespace (37466a8)
eslint-plugin-jsdoc - v20.3.0

Published by gajus almost 5 years ago

20.3.0 (2020-01-11)

Features

  • no-bad-blocks: add rule to check for multi-line-style comments which fail to meet criteria of a jsdoc block (4ce07d1)
eslint-plugin-jsdoc - v20.2.0

Published by gajus almost 5 years ago

20.2.0 (2020-01-11)

Features

  • no-defaults: add new rule to reports defaults on [@param](https://github.com/param) or [@default](https://github.com/default) and optionally report optional args; fixes #477 (d7fec9a)
eslint-plugin-jsdoc - v20.1.0

Published by gajus almost 5 years ago

20.1.0 (2020-01-11)

Features

  • require-hyphen-before-param-description: add option to support checking property/prop (1383c02)
eslint-plugin-jsdoc - v20.0.5

Published by gajus almost 5 years ago

20.0.5 (2020-01-08)

Performance Improvements

  • check-examples: avoid caching unused config (6cbf286)
eslint-plugin-jsdoc - v20.0.4

Published by gajus almost 5 years ago

20.0.4 (2020-01-08)

Bug Fixes

  • no-types, require-param: fixable meta should be code not true (b0aed65)
  • require-file-overview: omit fixable meta on non-fixable rule (efddc1c)
eslint-plugin-jsdoc - v20.0.3

Published by gajus almost 5 years ago

20.0.3 (2020-01-07)

Bug Fixes

  • check-property-names: check duplicate nested names (1c31782)
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