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 - 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)
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)
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