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 - v28.1.0

Published by gajus over 4 years ago

28.1.0 (2020-06-23)

Features

  • valid-types: disallow namepath on interface tag for Closure mode; continue checking on jsdoc; fixes part of #356 (#587) (794aea8)
eslint-plugin-jsdoc - v28.0.0

Published by gajus over 4 years ago

28.0.0 (2020-06-21)

Features

  • check-types, no-undefined-types, valid-types: use mode-aware type parsing; fixes part of #356; fixes #495 (6341e27)
  • check-types, no-undefined-types, valid-types: use mode-aware type parsing; fixes part of #356; fixes #495 (#586) (f98a8e4)

BREAKING CHANGES

  • check-types, no-undefined-types, valid-types: Requires Node 10+

Also:

  1. Adds "permissive" mode
  2. Checks "param" for valid namepaths
  • check-types, no-undefined-types, valid-types: Requires Node 10+

Also:

  1. Adds "permissive" mode
  2. Checks "param" for valid namepaths
  3. Refactors to use updated/better Node 10+ syntax/packages
eslint-plugin-jsdoc - v27.1.2

Published by gajus over 4 years ago

27.1.2 (2020-06-18)

Bug Fixes

  • require-jsdoc: place comment block above any decorators; fixes #571 (d5f8159)
eslint-plugin-jsdoc - v27.1.1

Published by gajus over 4 years ago

27.1.1 (2020-06-17)

Bug Fixes

  • no-undefined-types: if no scope found, resume checking current node for template tags; fixes #578, fixes #579 (fed7586)
eslint-plugin-jsdoc - v27.1.0

Published by gajus over 4 years ago

27.1.0 (2020-06-17)

Features

eslint-plugin-jsdoc - v27.0.7

Published by gajus over 4 years ago

27.0.7 (2020-06-14)

Bug Fixes

  • check-param-names, require-param: handle ts constructor as arg; fixes #576 (bd11a73)
eslint-plugin-jsdoc - v27.0.6

Published by gajus over 4 years ago

27.0.6 (2020-06-11)

Bug Fixes

  • check-param-names: destructured parameters inclusion check (params containing other params as substrings); closes #575 (f29f9e2)
eslint-plugin-jsdoc - v27.0.5

Published by gajus over 4 years ago

27.0.5 (2020-06-08)

Bug Fixes

  • check-param-names, require-param: handle TSIndexSignature early to avoid throwing; fixes #570 (5b814fc)
eslint-plugin-jsdoc - v27.0.4

Published by gajus over 4 years ago

27.0.4 (2020-06-04)

Bug Fixes

  • check-types: ensure conversion to [] array type also wraps unions in parentheses; fixes #565 (5714411)
eslint-plugin-jsdoc - v27.0.3

Published by gajus over 4 years ago

27.0.3 (2020-06-04)

Bug Fixes

  • no-undefined-types: handle missing comment nodes on ancestors; fixes #561 (0bc67fc)
eslint-plugin-jsdoc - v27.0.2

Published by gajus over 4 years ago

27.0.2 (2020-06-03)

Bug Fixes

  • no-undefined-types: avoid using flatMap for older Node; fixes #560 (cf6290f)
eslint-plugin-jsdoc - v27.0.1

Published by gajus over 4 years ago

27.0.1 (2020-06-03)

Bug Fixes

  • no-undefined-types: consider template type as defined when on functions within its scope; fixes part of #559 (f4d69ab)
eslint-plugin-jsdoc - v27.0.0

Published by gajus over 4 years ago

27.0.0 (2020-06-02)

Features

  • require-hyphen-before-param-description: add tags option for setting specific tags (or any tags) to follow rules for or against hyphen descriptions; now allows property to be set differently than param; fixes #553 (a764861)

BREAKING CHANGES

  • require-hyphen-before-param-description: {checkProperties: true} should be replaced by: {tags: {'property': 'always|never'}}
eslint-plugin-jsdoc - v26.0.2

Published by gajus over 4 years ago

26.0.2 (2020-06-02)

Bug Fixes

  • require-jsdoc: pass over decorators with nested arguments above class declarations in finding jsdoc block; fixes #557 (ca97fcf)
eslint-plugin-jsdoc - v26.0.1

Published by gajus over 4 years ago

26.0.1 (2020-05-31)

Bug Fixes

  • require-jsdoc: pass over decorator with parentheses above class declarations in finding jsdoc block; fixes #557 (67f5cd8)
eslint-plugin-jsdoc - v26.0.0

Published by gajus over 4 years ago

26.0.0 (2020-05-28)

Features

  • require-description-complete-sentence: add new option newlineBeforeCapsAssumesBadSentenceEnd which when false (the new default) will not assume caps after newlines is a bad sentence end. (7d4c399)

BREAKING CHANGES

  • require-description-complete-sentence: To restore the old behavior, the new option newlineBeforeCapsAssumesBadSentenceEnd must be set to true. This was changed from the default to decrease the false positives when capitalized letters on newlines merely represent proper nouns, etc.
eslint-plugin-jsdoc - v25.4.3

Published by gajus over 4 years ago

25.4.3 (2020-05-26)

Bug Fixes

  • require-jsdoc: ensure ArrowFunctionExpression potentially reported when part of AssignmentExpression; fixes #551 (d8c4e87)
eslint-plugin-jsdoc - v25.4.2

Published by gajus over 4 years ago

25.4.2 (2020-05-18)

Bug Fixes

  • require-returns: async with return should be documented; fixes #518 (99476af)
eslint-plugin-jsdoc - v25.4.1

Published by gajus over 4 years ago

25.4.1 (2020-05-14)

Bug Fixes

  • workaround for 'constructor' key in tagNamePreference; fixes #537 (ed0fa4e)
eslint-plugin-jsdoc - v25.4.0

Published by gajus over 4 years ago

25.4.0 (2020-05-13)

Features

  • require-param: add checkDestructured option; fixes #530 (4df57a8)
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