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 - v18.1.1

Published by gajus almost 5 years ago

18.1.1 (2019-11-19)

Bug Fixes

  • newline-after-description: handle carriage returns properly: fixes #431 (a38b28b)
eslint-plugin-jsdoc - v18.1.0

Published by gajus almost 5 years ago

18.1.0 (2019-11-19)

Features

  • check-values: add licensePattern option to allow delimiting portion of license description to extract (eed7dde)
eslint-plugin-jsdoc - v18.0.1

Published by gajus almost 5 years ago

18.0.1 (2019-11-13)

Bug Fixes

  • check-values: check for whole SPDX expression, not only single identifiers (e058efa)
eslint-plugin-jsdoc - v18.0.0

Published by gajus almost 5 years ago

18.0.0 (2019-11-13)

Bug Fixes

  • check-param-names: use ponyfill as such; avoid defining Object.entries when not present (ea1a626)

Features

  • check-access: add rule to check access levels (f919d5a)
  • empty-tags: expect certain tags to be empty (66ebda9)
  • check-values: add new rule for checking special tag values (within version, since, license, author) (5543c29)

BREAKING CHANGES

  • check-values: Adds to recommended.
  1. @version - Checks that there is a present and valid
    semver version value.
  2. @since - As with @version
  3. @license - Checks that there is a present and valid SPDX identifier
    or is present within an allowedLicenses option.
  4. @author - Checks there is a value present, and if the option
    allowedAuthors is present, ensure that the author value is one
    of these array items.
  • check-access: New rule updates recommended

Checks @access for allowed values and prohibits multiple access
modifier tags on the same block

  • empty-tags: Added rule to recommended.

May add additional tags to check for emptiness using tags option.

eslint-plugin-jsdoc - v17.1.2

Published by gajus almost 5 years ago

17.1.2 (2019-11-12)

Bug Fixes

  • no-undefined-types: do not crash on variadic arguments (eaf41ed)
  • no-undefined-types: properly parse template tag name(s) for defined types (5f48821)
  • no-undefined-types: surface jsdoctypeparser update to avoid errors with empty variadic argument; closes #419 (9124b7b)
eslint-plugin-jsdoc - v17.1.1

Published by gajus almost 5 years ago

17.1.1 (2019-11-08)

Bug Fixes

  • require-description-complete-sentence: allow pipe symbol at beginning/end of sentences; fixes #423 (0fb07c1)
eslint-plugin-jsdoc - v17.1.0

Published by gajus almost 5 years ago

17.1.0 (2019-11-04)

Features

  • getJSDocComment: ignore line comment (9d24b25)
eslint-plugin-jsdoc - v17.0.1

Published by gajus almost 5 years ago

17.0.1 (2019-11-03)

Bug Fixes

  • check-tag-names: ensure that the fenced block content of [@example](https://github.com/example) tags are not treated as jsdoc tags; fixes #395 (bfa237b)
eslint-plugin-jsdoc - v17.0.0

Published by gajus almost 5 years ago

17.0.0 (2019-11-01)

Features

  • no-undefined-types: only check [@template](https://github.com/template) in no-undefined-types for types in "closure" and "typescript" modes; fixes part of #356 (7583f16)

BREAKING CHANGES

  • no-undefined-types: @template has no special meaning for regular jsdoc (is not even allowed by default), so don't check in "jsdoc" mode.
eslint-plugin-jsdoc - v16.1.1

Published by gajus almost 5 years ago

16.1.1 (2019-10-29)

Bug Fixes

  • check-tag-names: add record and undocumented tags in Closure source to Closure tags; fixes #306 (42476b2)
eslint-plugin-jsdoc - v16.1.0

Published by gajus almost 5 years ago

16.1.0 (2019-10-29)

Features

  • check-types, no-undefined-types, valid-types: with settings.jsdoc.mode, only expect types on certain tags if in "closure" mode (42e8de2)
eslint-plugin-jsdoc - v16.0.0

Published by gajus almost 5 years ago

16.0.0 (2019-10-29)

Features

  • check-tag-names and other rules: begin settings.jsdoc.mode; utilize in getPreferredTagName, isValidTag, getTagsByType; fixes part of #356 (fd36278)

BREAKING CHANGES

  • check-tag-names and other rules: Allowable values: jsdoc|typescript|closure
eslint-plugin-jsdoc - v15.12.2

Published by gajus almost 5 years ago

15.12.2 (2019-10-29)

Bug Fixes

  • Alignment fixer should use indentation character from sourceCode. (2e3c3cd)
eslint-plugin-jsdoc - v15.12.1

Published by gajus almost 5 years ago

15.12.1 (2019-10-23)

Bug Fixes

  • require-jsdoc: avoid erring (or traversing) on object spread in parsing for defined symbols; fixes #378 (6ab617f)
eslint-plugin-jsdoc - v15.12.0

Published by gajus about 5 years ago

15.12.0 (2019-10-18)

Features

  • require-param: change fixer to fix all missing tags at once (fc4d68e)
eslint-plugin-jsdoc - v15.11.1

Published by gajus about 5 years ago

15.11.1 (2019-10-15)

Bug Fixes

  • valid-types: add undocumented modifies so its types will be checked (474ecb0)
eslint-plugin-jsdoc - v15.11.0

Published by gajus about 5 years ago

15.11.0 (2019-10-12)

Features

  • check-tag-names: allow undocumented jsdoc modifies tag and missing closure tags (e791ec3)
eslint-plugin-jsdoc - v15.10.1

Published by gajus about 5 years ago

15.10.1 (2019-10-12)

Bug Fixes

  • require-jsdoc: allow additional contexts to block preceeding export and find jsdoc (c0f4494)
eslint-plugin-jsdoc - v15.10.0

Published by gajus about 5 years ago

15.10.0 (2019-10-09)

Features

  • add require-param fixer (f5aa476)
  • require-param: add fixer (893916c)
eslint-plugin-jsdoc - v15.9.10

Published by gajus about 5 years ago

15.9.10 (2019-10-05)

Bug Fixes

  • check-types: surface jsdoctypeparser publishing fix for variadic without operand function(...) (impacting check-types fixes of such a type) (c0171c7)
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