Skip to content

Update dependency eslint-plugin-jsdoc to v32

Reiter, Christoph requested to merge renovate/eslint-plugin-jsdoc-32.x into master

This MR contains the following updates:

Package Type Update Change
eslint-plugin-jsdoc devDependencies major ^31.0.0 -> ^32.0.0

Release Notes

gajus/eslint-plugin-jsdoc

v32.2.0

Compare Source

Features
  • check-types: check settings.jsdoc.structuredTags for an array of permissible types, reporting if not present; fixes #​695 (9dad3e0)
  • no-undefined-types: allow structuredTags types to be auto-defined (b7198e4)

v32.1.1

Compare Source

Bug Fixes
  • check-param-names, require-jsdoc, require-param: avoid erring upon MemberExpression or other constructions within dynamic properties; fixes #​699 (1cfdeb4)

v32.1.0

Compare Source

Features
  • require-jsdoc: allow checking for getter or setter only; fixes #​515 (937d65e)

v32.0.3

Compare Source

Bug Fixes
  • require-jsdoc: more accurate and optimized decorator detection; fixes #​697 (88655b3)

v32.0.2

Compare Source

Bug Fixes
  • match-description: while preserving internal newlines, ensure trailing whitespace is stripped for comparisons; for #​692 (27b95b3)

v32.0.1

Compare Source

Bug Fixes
  • default to u flag for checkTypesPattern option for require-param, check-param-names; for check-values, default to u flag and allow slashed regexes with own flags; for match-description, allow slashed regexs with own flags; for all of the previous (and check-examples) allows newlines (4f0dc8e)

v32.0.0

Compare Source

Bug Fixes
  • check-examples: change default extension for simulated file name of [@example](https://github.com/example) from md to md/*.js. Only applies when matchingFileName is not used. (2cc1227)
BREAKING CHANGES
  • check-examples: Per update to eslint-plugin-markdown v2 and its support of ESLint 7's new processor API, fenced blocks can (and must) be targeted separately from the Markdown parent file as a whole, so in order to allow the same overrides config to be reusable between Markdown fenced blocks and @example tags (since one often wishes to disable the same kind of rules for each, being as that each may deliberately lack full context, e.g., undefined or unused variables), we update the default simulated extension set for @example tags by check-examples to simulate an expression which will now be a suitable choice for overrides in targeting Markdown fenced blocks using the new parser API, as with eslint-plugin-markdown@2 (i.e., "md/*.js" instead of "md").

If you need to use ESLint 6 (or eslint-plugin-markdown < 2, for example) with check-examples, you should be able to manually supply the matchingFileName option targeting "md", e.g., set to 'dummy.md.

This commit also simplifies a testing example to avoid it throwing with changed config not having proper babel support (not meaningful to test anyways)


Renovate configuration

📅 Schedule: "before 3am on Monday" (UTC).

🚦 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 Reiter, Christoph

Merge request reports