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 - 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)
eslint-plugin-jsdoc - v8.4.6

Published by gajus over 5 years ago

8.4.6 (2019-06-23)

Bug Fixes

  • require-jsdoc: support anonymous default with publicOnly (0bd35d1), closes #286
eslint-plugin-jsdoc - v8.4.5

Published by gajus over 5 years ago

8.4.5 (2019-06-23)

Bug Fixes

  • require-jsdoc: avoid error for unnamed default functions and classes (export default ...), though does not yet handle (d9fdc7a)
eslint-plugin-jsdoc - v8.4.4

Published by gajus over 5 years ago

8.4.4 (2019-06-22)

Bug Fixes

  • require-jsdoc: with eslint 6, we can't use schema for defaults, so revert to old approach (5e784ba)
eslint-plugin-jsdoc - v8.4.3

Published by gajus over 5 years ago

8.4.3 (2019-06-21)

Bug Fixes

  • make options schemas effective (5008fcf)
eslint-plugin-jsdoc - v8.4.2

Published by gajus over 5 years ago

8.4.2 (2019-06-21)

Bug Fixes

  • require-returns, require-returns-check: properly handle catch (ea8b0f7)
eslint-plugin-jsdoc - v8.4.1

Published by gajus over 5 years ago

8.4.1 (2019-06-21)

Bug Fixes

  • check-examples: include column delta preceding regex mtch when regex has no groups (b8e2085)
eslint-plugin-jsdoc - v8.4.0

Published by gajus over 5 years ago

8.4.0 (2019-06-21)

Features

  • check-types, no-undefined-types: report error if settings.jsdoc.preferredTypes item is not falsy/string/object (e273fba)
  • no-types, require-description: add missing meta.type ("suggestion" for both) (cd2d28e)
eslint-plugin-jsdoc - v8.3.2

Published by gajus over 5 years ago

8.3.2 (2019-06-21)

Bug Fixes

  • add flat-map-polyfill to dependencies and use in no-undefined-types in place of (unpublished and large) core-js (142ac17)
eslint-plugin-jsdoc - v8.3.1

Published by gajus over 5 years ago

8.3.1 (2019-06-21)

Bug Fixes

  • add core-js/fn/array/flat-map import to no-undefined-types to ensure flatMap support (2b41cb8)
  • use stable flat-map polyfill (8254e70)
eslint-plugin-jsdoc - v8.3.0

Published by gajus over 5 years ago

8.3.0 (2019-06-19)

Features

  • add array option exemptedBy on rules require-description and require-example (e8026e4)
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