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 - v11.2.0

Published by gajus over 5 years ago

11.2.0 (2019-07-06)

Features

  • match-description: allow description and desc tags to be matched for validation (9b63f40)
eslint-plugin-jsdoc - v11.1.0

Published by gajus over 5 years ago

11.1.0 (2019-07-06)

Features

  • require-description-complete-sentence: validate explicit description tags (97644cd)
eslint-plugin-jsdoc - v11.0.0

Published by gajus over 5 years ago

11.0.0 (2019-07-06)

Bug Fixes

  • check-types: remove template substitution variables, badType, preferredType, and replacement (#310) (854c8dd)

Features

  • remove preferredTypesDefined option in favor of making it apply automatically (2072735)
  • check-tag-names: auto-allow tags in tagNamePreference setting to be defined; add definedTags option to replace additionalTagNames.customTags setting (9df41d7)

BREAKING CHANGES

  • check-types: In place of the substitution variables, one must now hard-code the type in the message
  • One can no longer avoid preferredTypes types being treated as defined
  • check-tag-names: Switch additionalTagNames.customTags setting to definedTags option (only used by one rule)
eslint-plugin-jsdoc - v10.3.0

Published by gajus over 5 years ago

10.3.0 (2019-07-05)

Features

  • check-tag-names: allow rejecting normally valid tag names and/or providing custom error messages when suggesting tags to reject or replace (fixes #108) (a367c48)
eslint-plugin-jsdoc - v10.2.0

Published by gajus over 5 years ago

10.2.0 (2019-07-04)

Features

  • no-undefined-types: handle GCC generic functions (eacbe72)
eslint-plugin-jsdoc - v10.1.1

Published by gajus over 5 years ago

10.1.1 (2019-07-04)

Bug Fixes

  • reverse jsdoctypeparser update until traversal issue with "external:..." can be fixed (88fe68a)
eslint-plugin-jsdoc - v10.1.0

Published by gajus over 5 years ago

10.1.0 (2019-07-04)

Features

  • bump jsdoctypeparser to 5.0.0 (8f491ea)
eslint-plugin-jsdoc - v10.0.3

Published by gajus over 5 years ago

10.0.3 (2019-07-01)

Bug Fixes

  • check-types, no-undefined-types: add missing schemas for options (8cff358)
eslint-plugin-jsdoc - v10.0.2

Published by gajus over 5 years ago

10.0.2 (2019-06-30)

Bug Fixes

  • check-tag-names: if user targets aliases for renaming, these should have precedence over natural aliases (6baebd6)
eslint-plugin-jsdoc - v10.0.1

Published by gajus over 5 years ago

10.0.1 (2019-06-28)

Bug Fixes

  • no-undefined-types: problem with empty doc blocks (fixes #300) (4c4b9b5)
eslint-plugin-jsdoc - v10.0.0

Published by gajus over 5 years ago

10.0.0 (2019-06-27)

Features

  • match-description, require-jsdoc, require-description: remove noDefaults option and change contexts to always override defaults (2b10a7a)

BREAKING CHANGES

  • match-description, require-jsdoc, require-description: Forcing a release here: changes actually included in prior commits
eslint-plugin-jsdoc - v9.1.0

Published by gajus over 5 years ago

9.1.0 (2019-06-27)

Bug Fixes

  • match-description: tighten default regex to require punctuation at the end even if only a single character (58ca186)
  • match-description, require-description: allow contexts to work with any node type (299b095)

Features

  • match-description: allow mainDescription: string|false to override or disable main description separate from default (11cf9f5)
  • match-description: report line number and allow reporting multiple errors when main description validation fails (3b61dcc)
  • require-jsdoc: add contexts option to allow working with any node type (3e0775a)
eslint-plugin-jsdoc - v9.0.1

Published by gajus over 5 years ago

9.0.1 (2019-06-27)

Bug Fixes

  • valid-types: liberalize to allow second path to @borrows to be a name path beginning only with a name path operator, as jsdoc accepts (35df873)
eslint-plugin-jsdoc - v9.0.0

Published by gajus over 5 years ago

9.0.0 (2019-06-27)

Features

  • make some rules work on non-functions (5b379d9)

  • Merge pull request #298 from golopot/allnodes (f28f87f), closes #298

BREAKING CHANGES

  • a subset of rules updated to work on all JSDoc blocks rather than just function-like nodes

Changes apply to check-alignment, check-indentation, check-syntax, check-tag-names, check-types, newline-after-description, require-description-complete-sentence, require-hyphen-before-param-description, valid-types

  • previously rules mostly works only on function-like
    nodes, now a subset of rules are updated to work on all JSDocs.
eslint-plugin-jsdoc - v8.7.0

Published by gajus over 5 years ago

8.7.0 (2019-06-26)

Bug Fixes

  • getJSDocComment: Check for parents of ClassExpression and ObjectExpression (27c9b5c)
  • match-description: tighten default regex to require punctuation at the end even if only a single character (da3d139)

Features

  • match-description: allow main description: string|boolean to override or disable main description separate from default (314557c)
eslint-plugin-jsdoc - v8.6.2

Published by gajus over 5 years ago

8.6.2 (2019-06-26)

Bug Fixes

  • eslint: Add object expression in getJSDocComment (16b0288)
  • check for comments immediately above any node by default (8a03a5f)
  • check parents of ClassExpression for comment blocks (2ba2924)
eslint-plugin-jsdoc - v8.6.1

Published by gajus over 5 years ago

8.6.1 (2019-06-26)

Bug Fixes

  • check-examples: when matchingFileName used, properly copy parser and load external rules for eslint 6 (383a557)
eslint-plugin-jsdoc - v8.6.0

Published by gajus over 5 years ago

8.6.0 (2019-06-24)

Features

  • add plugins automatically to "recommended" config (dfa9b23)
eslint-plugin-jsdoc - v8.5.1

Published by gajus over 5 years ago

8.5.1 (2019-06-24)

Bug Fixes

  • require-description-complete-sentence: avoid erring with missing tags (fixes #290) (8ab2178)
eslint-plugin-jsdoc - v8.5.0

Published by gajus over 5 years ago

8.5.0 (2019-06-23)

Features

  • require-jsdoc: allow require to posses ClassExpression boolean property (92519e2)
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