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 - v20.0.2

Published by gajus almost 5 years ago

20.0.2 (2020-01-07)

Bug Fixes

  • check-param-names: check duplicate nested names; fixes #474 (c51d616)
eslint-plugin-jsdoc - v20.0.1

Published by gajus almost 5 years ago

20.0.1 (2020-01-07)

Bug Fixes

  • require-jsdoc: handle spread elements in typescript-eslint/parser; for #378 (3e8ea59)
eslint-plugin-jsdoc - v20.0.0

Published by gajus almost 5 years ago

20.0.0 (2020-01-02)

Features

  • check-examples: apply rules by default as if on current JavaScript file (though with md extension for easier automated overriding); fixes #434 (976cfc1)

refactoring

  • check-examples: rename eslintrcForExamples to checkEslintrc; also ensure matchingFileName always triggers config retrieval (5a85f0f)

BREAKING CHANGES

  • check-examples: This commit also clarifies new precedence and behavior in docs.
eslint-plugin-jsdoc - v19.2.0

Published by gajus almost 5 years ago

19.2.0 (2019-12-31)

Features

  • require-file-overview: allow user to specify whether checking for tag, duplicates, or preceding non-comments, and for which tags (f6e467e)
eslint-plugin-jsdoc - v19.1.0

Published by gajus almost 5 years ago

19.1.0 (2019-12-31)

Features

  • no-types, implements-on-classes: add contexts option which if set to any will allow checking of virtual functions (c4079b8)
  • require-param-*, require-returns-*, require-returns: allows contexts option to be set to "any" to check virtual function docs like [@callback](https://github.com/callback) or [@function](https://github.com/function) with [@interface](https://github.com/interface); fixes #406 (7500b00)
eslint-plugin-jsdoc - v19.0.1

Published by gajus almost 5 years ago

19.0.1 (2019-12-31)

Bug Fixes

  • require-file-overview: fix logic for detecting start of file (601e52d)
eslint-plugin-jsdoc - v19.0.0

Published by gajus almost 5 years ago

19.0.0 (2019-12-31)

Features

  • check-property-names: add rule to check for duplicated and improperly nested properties (492b814)

  • require-property:* add rules for ensuring property tags have a name, type, and/or description (in any context); fixes #409 (e5f2a23)

  • feat(require-property); add rule to check for property on typedef or namespace where the type is object; fixes #410 (68bf6cd), closes #410

BREAKING CHANGES

  • check-property-names: Adds new rule to recommended
  • require-property:* Adds rules to recommended
  • Adds new rule to recommended config.
eslint-plugin-jsdoc - v18.11.0

Published by gajus almost 5 years ago

18.11.0 (2019-12-31)

Features

  • match-description, require-description, require-example: allow "any" for contexts; fixes #325 (50d3b4d)
eslint-plugin-jsdoc - v18.10.0

Published by gajus almost 5 years ago

18.10.0 (2019-12-31)

Features

  • check-access: allow ignorePrivate setting to work with access private tag. (cf37cc6)
eslint-plugin-jsdoc - v18.9.0

Published by gajus almost 5 years ago

18.9.0 (2019-12-31)

Features

  • check-types: add option exemptTagContexts to exempt type-checking (certain types or any types) on specific tags; fixes #255 (5d99663)
eslint-plugin-jsdoc - v18.8.0

Published by gajus almost 5 years ago

18.8.0 (2019-12-31)

Features

  • require-description-complete-sentence: add abbreviations option; fixes #424 (f70fd6c)
eslint-plugin-jsdoc - v18.7.0

Published by gajus almost 5 years ago

18.7.0 (2019-12-31)

Features

  • require-file-overview: add rule for every file to have a file tag; fixes #55 (7839625)
eslint-plugin-jsdoc - v18.6.2

Published by gajus almost 5 years ago

18.6.2 (2019-12-28)

Bug Fixes

  • empty-tags: ensure rule is still checked when a private tag is present despite even a true ignorePrivate setting. (c5b8e09)
eslint-plugin-jsdoc - v18.6.1

Published by gajus almost 5 years ago

18.6.1 (2019-12-28)

Bug Fixes

  • ensure ignorePrivate setting works with iterateAllJsdocs rules (9703aba)
eslint-plugin-jsdoc - v18.6.0

Published by gajus almost 5 years ago

18.6.0 (2019-12-27)

Features

  • require-jsdoc: allow simple decorators to intervene between comment block and context object; fixes part of #455 (641479b)
eslint-plugin-jsdoc - v18.5.0

Published by gajus almost 5 years ago

18.5.0 (2019-12-27)

Features

  • check-param-names: add option allowExtraTrailingParamDocs to avoid reporting additional [@param](https://github.com/param)'s beyond actual function's arguments; fixes #450 (4532e66)
eslint-plugin-jsdoc - v18.4.4

Published by gajus almost 5 years ago

18.4.4 (2019-12-23)

Bug Fixes

  • require-returns: should only report errors with async functions when forceReturnsWithAsync is set (13f5533)
eslint-plugin-jsdoc - v18.4.3

Published by gajus almost 5 years ago

18.4.3 (2019-12-04)

Bug Fixes

  • require-param: update comment-parser to surface fix for asterisk followed immediately by non-space; add test; fixes #443 (dd5f015)
  • should apply corrected parse description for all rules as may otherwise parse previous tags differently (d6ccd45)
eslint-plugin-jsdoc - v18.4.2

Published by gajus almost 5 years ago

18.4.2 (2019-12-04)

Bug Fixes

  • check-types: surface jsdoctypeparser fix for new() with arrow functions; @Elberet (373fb43)
eslint-plugin-jsdoc - v18.4.1

Published by gajus almost 5 years ago

18.4.1 (2019-12-02)

Bug Fixes

  • check-param-names: failure to handle default params with spacing; closes #377 (c361ef6)
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