Pull request #85 · stacks/eslint-plugin

ℹ️ Note
This PR body was truncated due to platform limits.

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
eslint-plugin-jsdoc	`^50.6.14` → `^62.5.4`

Release Notes

gajus/eslint-plugin-jsdoc (eslint-plugin-jsdoc)

`v62.5.4`

Compare Source

Bug Fixes

no-undefined-types: avoid treating infer type identifier as undefined; fixes #1654 (da44046)
no-undefined-types: ensure template tags are defined; fixes #1655 (bfef848)

`v62.5.3`

Compare Source

Bug Fixes

default-expressions and examples configs: avoid applying deprecated rules now that ESLint warns against them; fixes #1651 (a252868)

`v62.5.2`

Compare Source

Bug Fixes

valid-types: allow numeric properties for jsdoc mode; fixes #1646 (122d283)

`v62.5.1`

Compare Source

Bug Fixes

require-template: stop treating type parameters names as unknown template names; fixes #1648 (dfc662e)
type-formatting: update jsdoccomment and devDeps.; fixes #1647 (19f36b6)

`v62.5.0`

Compare Source

Features

check-tag-names: add Typedoc include, includeCode, and TSDoc inheritDoc/inheritdoc and label to allowable inline tags; add TSDoc and typedoc tags (925f6e3)
require-description-complete-sentence: allow inline inheritDoc, inheritdoc, include, includeCode, label to avoid rule; fixes #1641 (c5a09c8)
valid-types: add Typedoc include, includeCode, and TSDoc inheritDoc/inheritdoc and label to allowable inline tags (c078633)

`v62.4.1`

Compare Source

`v62.4.0`

Compare Source

Features

type-formatting: support trailingPunctuationMultilineOnly boolean option; fixes #1636 (#1638) (3907822)

`v62.3.1`

Compare Source

Bug Fixes

update comment-parser, devDeps (#1637) (f443986)

Features

update jsdoccomment, allowing for skipInvokedExpressionsForCommentFinding setting; fixes #1624 (9c0e4a3)

BREAKING CHANGES

Require Node ^20.19.0 || ^22.13.0 || >=24

`v61.7.1`

Compare Source

Bug Fixes

github: npm release (#1623) (fe29ef9)

`v61.5.0`

Compare Source

Features

check-tag-names, require-template, check-template-names: make typeParam a non-preferred alias for template (3cd7cbd)

`v61.4.2`

Compare Source

Bug Fixes

require-rejects: reflect proper tag name in error message (44b2631)

`v61.4.1`

Compare Source

Bug Fixes

require-rejects: do not treat synchronous throw as rejection; fixes #1603 (f776d63)

`v61.4.0`

Compare Source

Features

add require-rejects rule; fixes #755 (99c7fbd)

`v61.3.0`

Compare Source

Features

allowIndentedSections option; fixes #541 (edaf615)

`v61.2.1`

Compare Source

Bug Fixes

require-param: ensure all structures with interfaces do not trigger with interfaceExemptsParamsCheck: true (39a5b0a)
tag-lines: avoid reformatting post-delimiter spacing; fixes #1593 (702b226)

`v61.2.0`

Compare Source

Features

sort-tags: add tagExceptions to allow additional lines per tag; fixes #1594 (85a1ea1)

`v61.1.12`

Compare Source

Bug Fixes

no-undefined-types: treat param names as defined; fixes #1591 (b47779c)

`v61.1.11`

Compare Source

Bug Fixes

fixing of missing parent should go between child and grandparent (4f2ec35)

`v61.1.10`

Compare Source

Bug Fixes

imports-as-dependencies: check for object-based types (or typings) (c9a22b6)

`v61.1.9`

Compare Source

Bug Fixes

CJS: provide CJS version of to-valid-identiifer; fixes #1583 (ca57a1f)

`v61.1.8`

Compare Source

Bug Fixes

no-undefined-types: consider module scope variables as defined; fixes #1581 (f938fdc)

`v61.1.7`

Compare Source

Bug Fixes

imports-as-dependencies: handle resolve.exports errors (0c4e5b6)

`v61.1.6`

Compare Source

Bug Fixes

imports-as-dependencies: check within exports for types; fixes #1114 (c0e4e7c)

`v61.1.5`

Compare Source

Bug Fixes

update object-deep-merge, devDeps.; closes #1576 (7a45e99)

`v61.1.4`

Compare Source

Bug Fixes

to-valid-identifier should be a dependency; fixes #1574 (89d37d0)

`v61.1.3`

Compare Source

Bug Fixes

prefer-import-tag: ensure import is a valid identifier; fixes #1572 (4349209)

`v61.1.2`

Compare Source

Bug Fixes

no-undefined-types: allow global prefixes; fixes #1566 (335450a)

`v61.1.1`

Compare Source

Bug Fixes

valid-types: reallow const type (75c8127)

`v61.1.0`

Compare Source

Features

ts-method-signature-style: add new rule (92bf39e)
ts-no-empty-object-type: new rule to prevent empty objects (a19af97)
ts-no-unnecessary-template-expression: create new rule to catch extra markup within template types (64082aa)
ts-prefer-function-type: add new rule (cbda8aa)

`v61.0.1`

Compare Source

Bug Fixes

require-yields-*, require-throws-*: ensure alias of throws (exception) and of yields (yield) are checked; fixes #1559 (#1560) (38770c4)

`v61.0.0`

Compare Source

Features

type-formatting: keyValuePostColonSpacing, keyValuePostKeySpacing, keyValuePostOptionalSpacing, keyValuePostVariadicSpacing for key-value pairs (and object fields) (ecf3a4a)
type-formatting: add genericAndTupleElementSpacing option for tuples and generics (2735b6d)
type-formatting: add parameterDefaultValueSpacing for type parameter spacing (b8eeca8)
type-formatting: add spacing for functions/classes and method quotes (a361dc9)
type-formatting: change stringQuotes default to double; fixes #1556 (0837647)

BREAKING CHANGES

type-formatting: Set stringQuotes option to single to restore old behavior

`v60.8.3`

Compare Source

Bug Fixes

valid-types: ensure safe for class context (this keyword) (87464a6)
valid-types: re-allow namepaths in name-definers like typedef in non-typescript mode; fixes #1557 (680cf1d)

`v60.8.2`

Compare Source

Bug Fixes

no-undefined-types: do not treat type parameters or their references as undefined; #1215 (#1553) (a5a0a3c)

`v60.8.1`

Compare Source

Bug Fixes

valid-types: parse distinctly for names vs. namepaths (#1552) (6efd9e9)

`v60.8.0`

Compare Source

Features

add name-defining role for likes of typedef as distinct from likes of param (#1551) (e67e474)

`v60.7.1`

Compare Source

Bug Fixes

prefer-import-tag: handle other cases of comments before structures early in the document; fixes #1549 (622b17e)

`v60.7.0`

Compare Source

Bug Fixes

prefer-import-tag: handle inserting before early comment nodes; fixes #1549 (9e92718)

Features

require-returns-check: add noNativeTypes option to assert async functions do not have native types as return types; fixes #1345 (13fe027)

`v60.6.0`

Compare Source

Features

escape-inline-tags: add new rule (#1547) (7a6b7db)

`v60.5.0`

Compare Source

Bug Fixes

no-undefined-types: avoid param and property tags from being treated as type-defining (f72ac1a)

Features

check-tag-names: add inlineTags option with default inline tag checking (f0515be)
require-template-description: add rule; fixes #1540 (90af18a)

`v60.4.1`

Compare Source

Bug Fixes

requireParam: update return type to include foundIndex and tagLineCount (#1531) (91e261d), closes #1530 #1530

`v60.4.0`

Compare Source

Bug Fixes

ensure permissive settings are converted for jsdoc-type-pratt-parser (065f11a)

Features

add flat/recommended-mixed config; fixes #1101 (68fad5b)

`v60.3.1`

Compare Source

Bug Fixes

getJsdocProcessPlugin: auto-escape *\/ and entities (#1537) (74186a3), closes #710

`v60.3.0`

Compare Source

Features

no-undefined-types: checkUsedTypedefs option; fixes #1165 (#1544) (001c4a9)

`v60.2.0`

Compare Source

Features

prefer-import-tags: add new rule; fixes #1314 (#1536) (376d583)

`v60.1.1`

Compare Source

Bug Fixes

reject-any-type, reject-function-type: prevent object replacement as with check-types; fixes #1538 (#1539) (0c4c654)

`v60.1.0`

Compare Source

Features

tag-lines: maxBlockLines option; fixes #1346 (#1532) (751428c)

`v60.0.0`

Compare Source

Bug Fixes

require-tags: change rule name to be consistent with other rules (#1535) (70c1b2e)

BREAKING CHANGES

require-tags: Changes required-tags to require-tags.

`v59.1.0`

Compare Source

Features

required-tags: add new rule; fixes #1235 (47299db)

`v59.0.2`

Compare Source

Bug Fixes

allow typedefs with no initial whitespace; fixes #1217 (c8612b2)

`v59.0.1`

Compare Source

Bug Fixes

require-yields-description, require-next-description: handle multiline descriptions; fixes #1528 (2544b12)
typescript: deprecate check-examples (9a2763b)

`v59.0.0`

Compare Source

Bug Fixes

require-yields-check: remove exemptedBy option (7209fe0)
correct fixable false positives (2ff5f14), closes #1266

Features

require-next-description, require-throws-decription, require-yields-description: add rules; fixes #1526 (214a5f2)

BREAKING CHANGES

require-yields-check: Removes exemptedBy from require-yields-check. Should not be needed.

Also:

docs: create options dynamically from schemas

`v58.1.1`

Compare Source

Bug Fixes

type-formatting: remove propertyIndent option; fixes #1524 (#1525) (1cf93b5)

`v58.1.0`

Compare Source

Features

require-param: add interfaceExemptsParamsCheck option; fixes #1511 (#1521) (a3bb85e)

`v58.0.0`

Compare Source

Bug Fixes

typescript: descriptions need tag Markdown escaping (52c0c16)

Features

add reject-any-type and reject-function-type rules and extraRuleDefinitions.preferTypes option (ae4e95d)

BREAKING CHANGES

The new rules are added to recommended configs

`v57.2.1`

Compare Source

Bug Fixes

typescript: ensure rules without a schema are represented as well (#1518) (c21a3f3)

`v57.2.0`

Compare Source

Features

check-types: deprecate unifyParentAndChildTypeChecks option in favor of new unifyParentAndChildTypeChecks preferredTypes[preferredType] setting (#1517) (224bbe6)

`v57.1.1`

Compare Source

Bug Fixes

typescript: add rule descriptions (#1516) (7e155be)

`v57.1.0`

Compare Source

Features

type-formatting: new objectFieldSeparatorOptionalLinebreak option (#1514) (6b20133)

`v57.0.10`

Compare Source

Bug Fixes

type-formatting: allow for $, _, and ZWNJ's without quoting (#1513) (dd0950b)

`v57.0.9`

Compare Source

Bug Fixes

type-formatting: do not strip quotes for objectFieldQuote when not an ID; always allow unescaped digits (d53884a)

`v57.0.8`

Compare Source

Bug Fixes

types: plugin property should be an intersection; fixes #1509 (#1510) (6692d0e)

`v57.0.7`

Compare Source

Bug Fixes

CJS export regression; fixes #1478 (#1508) (03a8a69)

`v57.0.6`

Compare Source

Bug Fixes

examples configs: disable @typescript-eslint/no-unsed-vars (#1507) (34e5910)

`v57.0.5`

Compare Source

Bug Fixes

types: add missing configs to index.configs type (#1505) (f019adf)

`v57.0.4`

Compare Source

Bug Fixes

jsdoc/examples/rules and jsdoc/default-expressions/rules configs: add @stylistic, @typescript-eslint, and eslint-plulgin-n equivalents to default disabled rules (#1504) (ab14982)

`v57.0.3`

Compare Source

Bug Fixes

valid-types: avoid reporting for next (handled by own rule) (#1503) (76b8406)

`v57.0.2`

Compare Source

Bug Fixes

extraRuleDefinitions.forbid jsdoc function option: point default link to advanced page (#1502) (91f1c30)

`v57.0.1`

Compare Source

Bug Fixes

require-next-type, require-throws-type, require-yields-type: fix URL; fixes #1500 (#1501) (33a4529)

`v57.0.0`

Compare Source

Features

extraRuleDefinitions.forbid option to jsdoc function (9f50083)
require-next-type, require-throws-type, require-yields-type: adds new rules and adds to recommended and required configs; fixes #1461 (0645428)

BREAKING CHANGES

require-next-type, require-throws-type, require-yields-type: It is unlikely to affect users but when using the jsdoc constructor with a recommended config , this commit removes throws and yields from the structuredTags settings recently added to the config output to require types for these tags in favor of the herein added equivalent recommended rules. (next is still part of structuredTags output, however, because this setting ensures the non-standard next tag is treated as allowable without need for separate configuration.)

Also:

chore: remove unused linting directives

`v56.1.2`

Compare Source

Bug Fixes

iterateJsdoc export: fix export (#1498) (be2b7ae)

`v56.1.1`

Compare Source

Bug Fixes

iterateJsdoc export: ensure default has type (#1497) (d5fb1d1)

`v56.1.0`

Compare Source

Features

type-formatting: add property, this, throws, and yields tags (#1496) (8886628)

`v56.0.2`

Compare Source

Bug Fixes

getJsdocComment, iterateJsdoc: fix CJS type declarations (#1493) (5f00672)

`v56.0.1`

Compare Source

Bug Fixes

export paths (#1492) (c29757d)

`v56.0.0`

Compare Source

Features

add CJS exports; fixes #1223 (#1491) (e3c8f1e)

BREAKING CHANGES

Changes exports paths. Should work without changes required.

`v55.4.0`

Compare Source

Features

type-formatting: add objectFieldSeparatorTrailingPunctuation option; fixes #1430 (5852fd9)
type-formatting: check type and typedef tags and add typeBracketSpacing option (77e1691)
type-formatting: enhance error detection and add unionSpacing option; fixes #1143 (cc7f253)

`v55.3.0`

Compare Source

Features

add type-formatting rule (81cb787)

`v55.2.0`

Compare Source

Features

copy over config properties (93e6b1c)

`v55.1.2`

Compare Source

Bug Fixes

typescript: allow string and numeric rule entries in config function (#1487) (2ccd629)

`v55.1.1`

Compare Source

Bug Fixes

typescript: include full set of declaration files (#1486) (a268541)

`v55.1.0`

Compare Source

Features

typescript: allow function to supply TS-aware rules (#1485) (ff4a55c)

`v55.0.5`

Compare Source

Bug Fixes

typescript: ensure configs available via config-building function (#1484) (23c9791)

`v55.0.4`

Compare Source

Bug Fixes

typescript: attempt to fix types export (#1483) (9261da0)

`v55.0.3`

Compare Source

Bug Fixes

typescript: remove properties from return value of config function (#1481) (e433f7d)

`v55.0.2`

Compare Source

Bug Fixes

ensure docs reflect proper usage of new jsdoc export function (#1480) (005c3fd)

`v55.0.1`

Compare Source

Bug Fixes

ensure CJS export is accessible; fixes #1478 (#1479) (c8ea39a)

`v55.0.0`

Compare Source

Features

export named function for building configs (#1477) (0b0a058)

BREAKING CHANGES

Although not technically breaking, this is being released as such to encourage use of the named import function.

import {jsdoc} from 'eslint-plugin-jsdoc'; // A named import now is encouraged export default [ ...jsdoc({config: 'flat/recommended'}); // Now invoke the function to build the config ];

`v54.7.0`

Compare Source

Features

revert "feat: export function for building configs (#1469)"; fixes #1474 (#1476) (427273e)

`v54.6.0`

Compare Source

Features

export function for building configs (#1469) (9fe05e0)

`v54.5.0`

Compare Source

Bug Fixes

require-template: check TSDeclareFunction (including overloads) for templates; fixes #1462 (2693a88)

Features

require-jsdoc, require-param: update jsdoccomment to disable overload skipping except conditionally for require-jsdoc with new on-by-default skipInterveningOverloadedDeclarations option; fixes #1434 (ed11968), closes #1369
require-jsdoc: add exemptOverloadedImplementations option (b29bc3a)

`v54.4.1`

Compare Source

Bug Fixes

getJsdocProcessorPlugin: reenable fixes (but disabling fixers for @example issues); fixes #1431 (#1473) (e45b726)

`v54.4.0`

Compare Source

Features

check-alignment: add innerIndent integer option; fixes #1351 (#1471) (784ce62)

`v54.3.1`

Compare Source

Bug Fixes

check-template-names, require-template: ensure template name is based on what is within any brackets and preceding equal sign; fixes #1466 (#1468) (5fbab65)

`v54.3.0`

Compare Source

Features

require-hyphen-before-param-description: when always is set, disallow hyphen at end of line; fixes #1435 (#1454) (95f3380)

`v54.2.1`

Compare Source

Bug Fixes

valid-types: try parsing whole item before splitting into commas; fixes #1464 (#1465) (8132392)

`v54.2.0`

Compare Source

Features

require-template: add exemptedBy; fixes [#

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

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

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

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

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.