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

Published by gajus over 5 years ago

15.4.0 (2019-07-13)

Bug Fixes

  • check-examples: preserve whitespace so as to report issues with whitespace-related rules such as indent (fixes #211) (cea3560)

Features

  • check-examples: add paddedIndent option (4c11c39)
eslint-plugin-jsdoc - v15.3.9

Published by gajus over 5 years ago

15.3.9 (2019-07-12)

Bug Fixes

  • newline-after-description: avoid matching duplicate or partial matches within tag descriptions after the block description; fixes #328 (c7f79fa)
eslint-plugin-jsdoc - v15.3.8

Published by gajus over 5 years ago

15.3.8 (2019-07-12)

Bug Fixes

  • require-description-complete-sentence: validate tags without names (e.g., beyond param/returns); fixes #333 (78f9b61)
eslint-plugin-jsdoc - v15.3.7

Published by gajus over 5 years ago

15.3.7 (2019-07-12)

Bug Fixes

  • check-examples: disallow empty caption (as with missing caption); fixes #330 (3c39014)
eslint-plugin-jsdoc - v15.3.6

Published by gajus over 5 years ago

15.3.6 (2019-07-12)

Bug Fixes

  • check-tag-names: loosen tag replacement to allow for no-space if at word boundary (as at end of line) (1145cd0)
  • check-tag-names: treat keys in tagNamePreference setting as defined so appropriate message will appear and fixer applied (2a605bf)
eslint-plugin-jsdoc - v15.3.5

Published by gajus over 5 years ago

15.3.5 (2019-07-11)

Bug Fixes

  • checkTagNames: #327 - Tag name autofix confused by adjacent tags (0a47c8f)
eslint-plugin-jsdoc - v15.3.4

Published by gajus over 5 years ago

15.3.4 (2019-07-10)

Bug Fixes

  • check-alignment, check-indentation, newline-after-description: report error line numbers (8f8431d)
  • check-indentation: check for indentation when no line breaks in doc block (006c140)
  • check-tag-names, check-types, no-undefined-types: ensure bad settings are reported as line 1 (1a13d8e)
eslint-plugin-jsdoc - v15.3.3

Published by gajus over 5 years ago

15.3.3 (2019-07-10)

Bug Fixes

  • check-syntax, implements-on-classes: report error line numbers (4049db1)
eslint-plugin-jsdoc - v15.3.2

Published by gajus over 5 years ago

15.3.2 (2019-07-09)

Bug Fixes

  • require-description-complete-sentence: report proper line numbers (fixes #160) (37081d2)
eslint-plugin-jsdoc - v15.3.1

Published by gajus over 5 years ago

15.3.1 (2019-07-09)

Bug Fixes

  • require-description-complete-sentence: let fixer work with question and exclamation marks at sentence end (fixes part of #16) (456206e)
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)
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