v36.1.1

Compare Source

Bug Fixes

• check-indentation: ensure decorators in fenced code blocks do not terminate ignoring of indentation in code blocks; fixes #​789 (0f4d8e0)

v36.1.0

Compare Source

Bug Fixes

• check-values: avoid capturing carriage return with license check; fixes #​783 (98a6d35)

Features

• add ignoreReplacesDocs setting (defaulting to true); fixes #​780 (#​781) (f8297aa)

v36.0.8

Compare Source

Bug Fixes

• with comment-parser allowing lower version, liberalize engines; fixes #​774 (63640e0)

v36.0.7

Compare Source

Bug Fixes

• tag-lines: schema fix for tags (#​775) (135a356)

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

• peg jsdoccomment version for now; fixes #​772 (c9b854b)

v35.5.0

Compare Source

Features

• require-returns-check: add exemptGenerators option (default on for typescript mode) to allow [@returns](https://redirect.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://redirect.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

• no-missing-syntax: fix message; closes #​761 (317674c)

v35.4.0

Compare Source

Features

• message options for match-description; fixes #​688 (7257e44)

v35.3.2

Compare Source

Bug Fixes

• stop reporting for async functions with throw missing [@throws](https://redirect.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

• match-name rule; fixes #​509 (eff90bd)

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

• check-line-alignment: add multiline type workaround (#​744); fixes part of #​743 (9928298)

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

• new rule tag-line; fixes #​93 (851e3fe)

v34.3.0

Compare Source

Features

• check-values: ensure [@variation](https://redirect.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

• require engines Node 12+ (#​726) (a0ee0a6)

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

• add require-asterisk-prefix rule (#​446) (f892338), closes #​199

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.

v32.3.4

Compare Source

Bug Fixes

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

v32.3.3

Compare Source

Bug Fixes

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

v32.3.2

Compare Source

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)

v32.3.1

Compare Source

Bug Fixes

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

v32.3.0

Compare Source

Features

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

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://redirect.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)