32.3.4 (2021-04-30)

Bug Fixes

• preserve newlines in tag description comparisons; fixes #692 (7edaed3)

32.3.3 (2021-04-28)

Bug Fixes

• require-param, check-param-names: do not fail with destructured array pattern containing empty slots; fixes #716 (f19e706)

32.3.2 (2021-04-26)

Bug Fixes

• check-line-alignment: prevent false never reporting where a space is present (post tag) followed by missing space (from a wholly missing type) and then a space (but a space first preceded by content (a name); fixes #714 (2c31db1)

32.3.1 (2021-04-23)

Bug Fixes

• check-examples: disable chai-friendly/no-unused-expressions for default expression rules (06f0112)

32.3.0 (2021-03-15)

Features

• check-tag-names: jsxTags an opt-in option for jsx annotations (8afb9fc)

32.2.0 (2021-02-23)

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)

32.1.1 (2021-02-23)

Bug Fixes

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

32.1.0 (2021-02-21)

Features

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

32.0.3 (2021-02-21)

Bug Fixes

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

32.0.2 (2021-02-16)

Bug Fixes

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

32.0.1 (2021-02-16)

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)

32.0.0 (2021-02-15)

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)

31.6.1 (2021-02-07)

Bug Fixes

• update comment-parser; fixes #686 (7e0bbbe)

31.6.0 (2021-01-31)

Bug Fixes

• require-returns, require-yields: support more AST checking (6fd8a07)
• require-yields: avoid checking nested generators (as with functions) (b9058e4)
• return-yields, return-yields-check: allow generator detection on exported; handle more AST types; fixes #682 (4e768aa)

Features

• require-returns-check: add exemptAsync option (0ed24c0)

31.5.0 (2021-01-31)

Bug Fixes

• require-returns: check labeled statements (51f37f1)
• require-throws: check labeled statements (ceadcfe)
• require-yields: check test part of if expression and check conditionals (db001be)
• require-yields: check labeled statements (aceb7a0)

Features

• require-returns: if function returns a Promise whose executor resolves with undefined, avoid need to document unless forceReturnsWithAsync is set; fixes #550 (565fdbd)

31.4.0 (2021-01-27)

Bug Fixes

• check-line-alignment: escape user tag name in regex (c0ae4cb)

Features

• check-line-alignment: allow tags option to configure which tags should be aligned. (780b8b5)

31.3.3 (2021-01-25)

Bug Fixes

• check-line-alignment: apply alignment to return tags and avoid possibility for "never" option to insert extra space with returns/return as well as handle missing type (cb39556)

31.3.2 (2021-01-24)

Bug Fixes

• while a fix provided for decorator detection and useful for inserting empty jsdoc blocks when fixers are enabled, it appears to have a 25% or so degradation in performance when tested with a large repository, so reverting. (e08d889)

Reverts

• Revert "optimize: ensure with new fix that we avoid checking back too far" (0fc4663)

31.3.1 (2021-01-24)

Bug Fixes

• bug with false positive decorator detection (evident sans semi-colons); e.g., require-jsdoc fixer (6bda6b4)

31.3.0 (2021-01-24)

Features

• check-param-names: add options disableExtraPropertyReporting to allow extra properties to be documented without error (as long as there are no siblings destructured as for such cases, they will still be expected since the function is not using them) (8b2d143)