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 - v22.0.0

Published by gajus over 4 years ago

22.0.0 (2020-03-01)

BREAKING CHANGES

  • Drops ESLint@5 support
eslint-plugin-jsdoc - v21.0.0

Published by gajus over 4 years ago

21.0.0 (2020-01-25)

Bug Fixes

  • check-param-names, check-property-names, require-file-overview: avoid direct use of uncertain license of object.entries-ponyfill; closes #487 (4403fb0)

BREAKING CHANGES

  • check-param-names, check-property-names, require-file-overview: Now requires Node >= 8
eslint-plugin-jsdoc - v20.4.0

Published by gajus over 4 years ago

20.4.0 (2020-01-23)

Features

eslint-plugin-jsdoc - v20.3.1

Published by gajus almost 5 years ago

20.3.1 (2020-01-15)

Bug Fixes

  • check-values: allow [@version](https://github.com/version) and [@since](https://github.com/since) to have versions surrounded by whitespace (37466a8)
eslint-plugin-jsdoc - v20.3.0

Published by gajus almost 5 years ago

20.3.0 (2020-01-11)

Features

  • no-bad-blocks: add rule to check for multi-line-style comments which fail to meet criteria of a jsdoc block (4ce07d1)
eslint-plugin-jsdoc - v20.2.0

Published by gajus almost 5 years ago

20.2.0 (2020-01-11)

Features

  • no-defaults: add new rule to reports defaults on [@param](https://github.com/param) or [@default](https://github.com/default) and optionally report optional args; fixes #477 (d7fec9a)
eslint-plugin-jsdoc - v20.1.0

Published by gajus almost 5 years ago

20.1.0 (2020-01-11)

Features

  • require-hyphen-before-param-description: add option to support checking property/prop (1383c02)
eslint-plugin-jsdoc - v20.0.5

Published by gajus almost 5 years ago

20.0.5 (2020-01-08)

Performance Improvements

  • check-examples: avoid caching unused config (6cbf286)
eslint-plugin-jsdoc - v20.0.4

Published by gajus almost 5 years ago

20.0.4 (2020-01-08)

Bug Fixes

  • no-types, require-param: fixable meta should be code not true (b0aed65)
  • require-file-overview: omit fixable meta on non-fixable rule (efddc1c)
eslint-plugin-jsdoc - v20.0.3

Published by gajus almost 5 years ago

20.0.3 (2020-01-07)

Bug Fixes

  • check-property-names: check duplicate nested names (1c31782)
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)
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