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 - v15.3.0

Published by gajus over 5 years ago

15.3.0 (2019-07-08)

Features

  • require-example: add contexts array option (of AST types) to allow overriding enforced contexts (fixes #273) (76771cb)
eslint-plugin-jsdoc - v15.2.0

Published by gajus over 5 years ago

15.2.0 (2019-07-08)

Features

  • check-examples: apply to all contexts (9fe4989)
eslint-plugin-jsdoc - v15.1.0

Published by gajus over 5 years ago

15.1.0 (2019-07-08)

Features

  • bump jsdoctypeparser to 5.0.1 (7400ee7)
eslint-plugin-jsdoc - v15.0.1

Published by gajus over 5 years ago

15.0.1 (2019-07-08)

Bug Fixes

  • check-param-names: report proper line numbers (fixes #48) (aff7358)
eslint-plugin-jsdoc - v15.0.0

Published by gajus over 5 years ago

15.0.0 (2019-07-08)

Features

  • require-description: add descriptionStyle option to accept implicit descriptions as satisfying the rule by default (fixes #301) (616bc83)

BREAKING CHANGES

  • require-description: To restore old behavior, set the option descriptionStyle to "tag"
eslint-plugin-jsdoc - v14.1.0

Published by gajus over 5 years ago

14.1.0 (2019-07-08)

Features

  • match-description: allow arbitrary tags; also fixes returns/return to avoid skipping matching of an initial "name" and space (9263fba)
eslint-plugin-jsdoc - v14.0.0

Published by gajus over 5 years ago

14.0.0 (2019-07-07)

Features

  • require-param: remove deprecated settings allowOverrideWithoutParam, allowImplementsWithoutParam, allowAugmentsExtendsWithoutParam (39c1e11)

BREAKING CHANGES

  • require-param: Removes the following settings in favor of mentioned replacements ettings:
  • settings.jsdoc.allowOverrideWithoutParam - replaced by settings.jsdoc.overrideReplacesDocs
  • settings.jsdoc.allowImplementsWithoutParam - replaced by settings.jsdoc.implementsReplacesDocs
  • settings.jsdoc.allowAugmentsExtendsWithoutParam - replaced by settings.jsdoc.augmentsExtendsReplacesDocs
eslint-plugin-jsdoc - v13.0.0

Published by gajus over 5 years ago

13.0.0 (2019-07-07)

Features

  • check-examples: move settings to options (fixes #216) (c4f221d)

BREAKING CHANGES

  • check-examples: The following settings have been removed and became options
    under check-examples

  • settings.jsdoc.exampleCodeRegex

  • settings.jsdoc.rejectExampleCodeRegex

  • settings.jsdoc.matchingFileName

  • settings.jsdoc.baseConfig

  • settings.jsdoc.configFile

  • settings.jsdoc.eslintrcForExamples

  • settings.jsdoc.allowInlineConfig

  • settings.jsdoc.reportUnusedDisableDirectives

  • settings.jsdoc.captionRequired

  • settings.jsdoc.noDefaultExampleRules

eslint-plugin-jsdoc - v12.0.0

Published by gajus over 5 years ago

12.0.0 (2019-07-07)

Features

  • require-example: move settings to options (407d3a9)
  • require-jsdoc: move settings to options (9f9f4fb)
  • require-returns: move settings to options (76e1e97)
  • valid-types: move settings to options (06cb22e)

BREAKING CHANGES

  • require-returns: The following settings has been removed and became options
    under relevant rules.
    • settings.jsdoc.allowEmptyNamepaths -> option in valid-types
    • settings.jsdoc.checkSeesForNamepaths -> option in valid-types
    • settings.jsdoc.exemptEmptyFunctions -> option in require-jsdoc
    • settings.jsdoc.forceRequireReturn -> option in require-returns
    • settings.jsdoc.avoidExampleOnConstructors -> option in require-example
eslint-plugin-jsdoc - v11.2.1

Published by gajus over 5 years ago

11.2.1 (2019-07-06)

Bug Fixes

  • check-examples: make escape-regex-string a dependency, as it should have been (fixes #314) (ed56935)
eslint-plugin-jsdoc - v11.2.0

Published by gajus over 5 years ago

11.2.0 (2019-07-06)

Features

  • match-description: allow description and desc tags to be matched for validation (9b63f40)
eslint-plugin-jsdoc - v11.1.0

Published by gajus over 5 years ago

11.1.0 (2019-07-06)

Features

  • require-description-complete-sentence: validate explicit description tags (97644cd)
eslint-plugin-jsdoc - v11.0.0

Published by gajus over 5 years ago

11.0.0 (2019-07-06)

Bug Fixes

  • check-types: remove template substitution variables, badType, preferredType, and replacement (#310) (854c8dd)

Features

  • remove preferredTypesDefined option in favor of making it apply automatically (2072735)
  • check-tag-names: auto-allow tags in tagNamePreference setting to be defined; add definedTags option to replace additionalTagNames.customTags setting (9df41d7)

BREAKING CHANGES

  • check-types: In place of the substitution variables, one must now hard-code the type in the message
  • One can no longer avoid preferredTypes types being treated as defined
  • check-tag-names: Switch additionalTagNames.customTags setting to definedTags option (only used by one rule)
eslint-plugin-jsdoc - v10.3.0

Published by gajus over 5 years ago

10.3.0 (2019-07-05)

Features

  • check-tag-names: allow rejecting normally valid tag names and/or providing custom error messages when suggesting tags to reject or replace (fixes #108) (a367c48)
eslint-plugin-jsdoc - v10.2.0

Published by gajus over 5 years ago

10.2.0 (2019-07-04)

Features

  • no-undefined-types: handle GCC generic functions (eacbe72)
eslint-plugin-jsdoc - v10.1.1

Published by gajus over 5 years ago

10.1.1 (2019-07-04)

Bug Fixes

  • reverse jsdoctypeparser update until traversal issue with "external:..." can be fixed (88fe68a)
eslint-plugin-jsdoc - v10.1.0

Published by gajus over 5 years ago

10.1.0 (2019-07-04)

Features

  • bump jsdoctypeparser to 5.0.0 (8f491ea)
eslint-plugin-jsdoc - v10.0.3

Published by gajus over 5 years ago

10.0.3 (2019-07-01)

Bug Fixes

  • check-types, no-undefined-types: add missing schemas for options (8cff358)
eslint-plugin-jsdoc - v10.0.2

Published by gajus over 5 years ago

10.0.2 (2019-06-30)

Bug Fixes

  • check-tag-names: if user targets aliases for renaming, these should have precedence over natural aliases (6baebd6)
eslint-plugin-jsdoc - v10.0.1

Published by gajus over 5 years ago

10.0.1 (2019-06-28)

Bug Fixes

  • no-undefined-types: problem with empty doc blocks (fixes #300) (4c4b9b5)
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