Skip to content

Update dependency eslint-plugin-jsdoc to v36

This MR contains the following updates:

Package Change Age Adoption Passing Confidence
eslint-plugin-jsdoc 32.3.4 -> 36.0.7 age adoption passing confidence

Release Notes

gajus/eslint-plugin-jsdoc

v36.0.7

Compare Source

Bug Fixes

v36.0.6

Compare Source

Bug Fixes
  • include comment-parser patched version (0ace59d)

v36.0.5

Compare Source

Bug Fixes
  • update jsdoccomment and jsdoc-type-pratt-parser (80334d8)

v36.0.4

Compare Source

Bug Fixes
  • update jsdoccomment (in case executing version (like IDE) is an older version not affected by engines, should now work) (508bf18)

v36.0.3

Compare Source

Bug Fixes
  • update dep. jsdoccomment (c8eee8f)

v36.0.2

Compare Source

Bug Fixes
  • carriage returns and fixers (f9a27e3)

v36.0.1

Compare Source

Bug Fixes
  • trigger new release which for Node 14 requires at least ^14.14.0 (a469b83)

v36.0.0

Compare Source

chore
  • require Node ^12.20, ^14.13, or 16+ for exports pattern support (9eed57e)
BREAKING CHANGES
  • Update to minimum versions needed by comment-parser ESM update

v35.5.1

Compare Source

Bug Fixes

v35.5.0

Compare Source

Features
  • require-returns-check: add exemptGenerators option (default on for typescript mode) to allow [@returns](https://github.com/returns) to be present even without return (8ef41a1)

v35.4.7

Compare Source

Bug Fixes
  • require-returns: handle contexts TSFunctionType, TSMethodSignature, MethodDefinition; fixes #​767 (fdca227)

v35.4.6

Compare Source

Bug Fixes
  • require-param: if adding params, convert single-line block to multiline; fixes #​771 (641cdee)

v35.4.5

Compare Source

Bug Fixes
  • valid-types: allow and require types on [@extends](https://github.com/extends) for TypeScript as used in docs (and not name) (6989699)

v35.4.4

Compare Source

Bug Fixes
  • tag-lines: allow any in tags[tag].lines option to allow lines per tag when otherwise blocked (52d7eff)

v35.4.3

Compare Source

Bug Fixes
  • check-line-alignment: preserve carriage returns; fixes #​745 (27521d2)

v35.4.2

Compare Source

Bug Fixes
  • check-examples: auto-disable no-empty-function rule for expression checking; clear it is a no-op in this context (5a928db)

v35.4.1

Compare Source

Bug Fixes

v35.4.0

Compare Source

Features

v35.3.2

Compare Source

Bug Fixes
  • stop reporting for async functions with throw missing [@throws](https://github.com/throws); fixes #​722 (f7c8038)

v35.3.1

Compare Source

Bug Fixes
  • valid-types: parse name paths as permissive. (657c67c)

v35.3.0

Compare Source

Features

v35.2.0

Compare Source

Features
  • no-missing-syntax, no-restricted-syntax, etc.: assume any context if context omitted (2dcd9ad)

v35.1.3

Compare Source

Bug Fixes
  • require-jsdoc: exemptEmptyFunctions option could trigger problematic return value checking behavior with no-argument functions (3089a92)

v35.1.2

Compare Source

Bug Fixes
  • update jsdoc-type-pratt-parser (1745fca)

v35.1.1

Compare Source

Bug Fixes
  • update jsdoc-type-pratt-parser (liberalizes ID start to support underscores and start/continue to support other Unicode) (1a6de5e)

v35.1.0

Compare Source

Bug Fixes
  • no-missing-syntax, no-restricted-syntax: support "any" with comment including global comments (dc641cc)
Features
  • use jsdoc-type-pratt-parser (647d47e)

v35.0.0

Compare Source

Bug Fixes
  • multiline-blocks: Enable (noZeroLineText and noFinalLineText will apply by default) (b81e25d)
BREAKING CHANGES
  • multiline-blocks: Should have been enabled by default

Also adds newer rules to doc listing

v34.8.2

Compare Source

Bug Fixes

v34.8.1

Compare Source

Bug Fixes
  • tag-lines: avoid false positive for "never" when line break occurs in the middle of a tag description. (3496011)
  • tag-lines: ensure a middle-of-block empty line doesn't suppress "always" errors (33aa921)

v34.8.0

Compare Source

Features
  • tag-lines: add tags option to override behavior on a tag-specific basis (including only applying to tag(s)); fixes #​734 (6e5e76d)

v34.7.0

Compare Source

Features
  • multiline-blocks: add noFinalLineText option; fixes #​738 (03d3f40)

v34.6.3

Compare Source

Bug Fixes
  • multiline-blocks: fix merging of lines to prevent removal of spaces, though removing where needed (9af6e36)

v34.6.2

Compare Source

Bug Fixes
  • multiline-blocks: ensure noZeroLineText checks when noMultilineBlocks is true but not matching; fixes #​737 (19f60ac)

v34.6.1

Compare Source

Bug Fixes
  • no-multi-asterisks: avoid false positives and erring in fixer of single line blocks; fixes #​735 (355da58)

v34.6.0

Compare Source

Features
  • no-multi-asterisks rule to prevent multiple asterisks with middle delimiters or at end of blocks (8848246)

v34.5.0

Compare Source

Features
  • multiline-blocks: allow control of how and whether jsdoc blocks can be expressed as single or multiple line blocks (06bbf37)

v34.4.0

Compare Source

Features

v34.3.0

Compare Source

Features
  • check-values: ensure [@variation](https://github.com/variation) is a positive integer (56577ce)

v34.2.2

Compare Source

Bug Fixes
  • check-param-names: adjusts line numbers to be nearer problematic item (e6c9ab2)
  • no-missing-syntax: pass in missing comment (a977896)

v34.2.1

Compare Source

Bug Fixes
  • require-description, require-example: for missing description, use tag line number (310ea75)

v34.2.0

Compare Source

Features
  • no-bad-blocks: add preventAllMultiasteriskBlocks boolean option to allow reporting of any multi-asterisked multiline comments (9669fc3)

v34.1.0

Compare Source

Features
  • check-line-alignment: add preserveMainDescriptionPostDelimiter option to preserve left-hand side spacings in the main description when using the always option. (54dac34)

v34.0.2

Compare Source

Bug Fixes
  • no-bad-blocks: avoid allowing 3+ asterisks with tag content (as with only 1 asterisk) (28397c7)

v34.0.1

Compare Source

Bug Fixes
  • multiline tag fixers omitting subsequent tag lines with new command-parser API (8fa7f9b)

v34.0.0

Compare Source

chore
BREAKING CHANGES
  • Also:
  • Build: Switch to Node 12 target
  • Linting: Use flat API
  • Travis: Add Node 16, remove Node 10
  • npm: Update devDep.

v33.3.0

Compare Source

Features
  • check-line-alignment: allow tags option to apply with "always"; #​703 (4421e4e)

v33.2.0

Compare Source

Features

v33.1.1

Compare Source

Bug Fixes
  • update jsdoccomment to surface fixes (7de397b)

v33.1.0

Compare Source

Features
  • support comment-selector-based contexts (f73c72c)
  • support comment-selector-based contexts (6e835fd)

v33.0.0

Compare Source

chore
  • use external @es-joy/jsdoccomment for getJSDocComment functionality (aa77e3b)
BREAKING CHANGES
  • Should only be breaking for anyone requiring the getJSDocComment file.

Also updates Babel devDeps.


Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.


  • If you want to rebase/retry this MR, check this box.

This MR has been generated by Renovate Bot.

Edited by Particify Dependency Bot

Merge request reports