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

Published by gajus almost 5 years ago

18.4.0 (2019-12-02)

Features

  • check-examples: add no-multiple-empty-lines by default (67df3dd)
eslint-plugin-jsdoc - v18.3.0

Published by gajus almost 5 years ago

18.3.0 (2019-12-01)

Features

  • validateDescription: tighten constraint (3b5e301)
eslint-plugin-jsdoc - v18.2.2

Published by gajus almost 5 years ago

18.2.2 (2019-12-01)

Bug Fixes

  • valid-types: ensure reporting "must have a type" when type is known to be required (b36053e)
  • valid-types: ensure when in closure mode, that this and define tags have types (b6e2699)
eslint-plugin-jsdoc - v18.2.1

Published by gajus almost 5 years ago

18.2.1 (2019-12-01)

Bug Fixes

  • check-types, no-undefined-types, valid-types: look within curly brackets of this and define tags (and if present within export) when in Closure mode; fixes #430 (7022f65)
eslint-plugin-jsdoc - v18.2.0

Published by gajus almost 5 years ago

18.2.0 (2019-11-30)

Features

  • check-examples: support global regexes and other flags besides now default "u" (i.e., any of gimys); fixes #331 (5587e02)
eslint-plugin-jsdoc - v18.1.6

Published by gajus almost 5 years ago

18.1.6 (2019-11-30)

Bug Fixes

  • check-examples: only exclude optional initial space from description, not initial newline (needed for line counts, and rules) (0e89cc8)
eslint-plugin-jsdoc - v18.1.5

Published by gajus almost 5 years ago

18.1.5 (2019-11-25)

Bug Fixes

  • newline-after-description: correctly treat carriage return immediately after newline as ending with a newline; fixes #437 (2fd8ecc)
  • newline-after-description: when finding last description line, don't look beyond the length of the description. (242202f)
eslint-plugin-jsdoc - v18.1.4

Published by gajus almost 5 years ago

18.1.4 (2019-11-20)

Bug Fixes

  • ensure comment is only matched by /**\s at beginning of text (eeab3d2)
eslint-plugin-jsdoc - v18.1.3

Published by gajus almost 5 years ago

18.1.3 (2019-11-20)

Bug Fixes

  • newline-after-description: only treat comments with whitespace after two asterisks only as jsdoc (3d61126)
eslint-plugin-jsdoc - v18.1.2

Published by gajus almost 5 years ago

18.1.2 (2019-11-19)

Bug Fixes

  • newline-after-description: avoid erring on encountering sequence of carriage returns (or other non-whitespace) as sole content of jsdoc block description (fixes #433) (e453b2d)
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)
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