Pull request #60 · stacks/eslint-plugin

Coming soon: The Renovate bot (GitHub App) will be renamed to Mend. PRs from Renovate will soon appear from 'Mend'. Learn more here.

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
eslint-plugin-jsdoc	`^50.6.14` -> `^57.2.1`

Release Notes

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

`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

`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

`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 #1460 (#1463) (09ee4ab)

`v54.1.1`

Compare Source

Bug Fixes

valid-types: allow extends for namepath; fixes #1455 (#1456) (3bf911c)

`v54.1.0`

Compare Source

Features

update devDeps. (#1451) (e51a7a8)

`v54.0.0`

Compare Source

Bug Fixes

revert "fix: move to tsdown for proper types (#1447)" (#1450) (aeb97bf)

BREAKING CHANGES

tsdown fix still not working properly, so reverting.

This reverts commit b19f6f9.

`v53.0.1`

Compare Source

Bug Fixes

no-types, require-example, implements-on-classes: allow any to match function variable declarations; fixes #1446 (#1448) (0867728)

`v53.0.0`

Compare Source

Bug Fixes

move to tsdown for proper types (#1447) (b19f6f9)

BREAKING CHANGES

Changes exports and build routine for proper types.
refactor: move to tsdown (take 2)
chore: remove unused devDeps. and fix generateRule script
fix bad rebase

`v52.0.4`

Compare Source

Bug Fixes

revert "fix: move to tsdown for proper types (#1440)"; fixes #1443 (#1444) (43e7e6d)

`v52.0.3`

Compare Source

Bug Fixes

move to tsdown for proper types (#1440) (af03395)

`v52.0.2`

Compare Source

Bug Fixes

jsdocProcessorPlugin types (#1441) (e9b0877)

`v52.0.1`

Compare Source

Bug Fixes

npmignore (#1439) (da66683), closes #1432

`v52.0.0`

Compare Source

Bug Fixes

use v flag in regexes; match emojis for sentence terminator; fixes #1433 (#1437) (5c2165c)

BREAKING CHANGES

Uses v flag instead of u flag by default for regular expressions

`v51.4.1`

Compare Source

Bug Fixes

disallow extra properties in rule options (#1429) (b462e44)

`v51.4.0`

Compare Source

Features

check-line-alignment: add template to default tags (#1427) (4c65cbe)

`v51.3.4`

Compare Source

Bug Fixes

no-undefined-types: exempt global requires from undefined property checks; fixes #1425 (#1426) (c51ee4f)

`v51.3.3`

Compare Source

Bug Fixes

no-undefined-types: add Intl to global types and ensure arbitrary properties of globals can be addressed; fixes #1423 (#1424) (feb65e4)

`v51.3.2`

Compare Source

Bug Fixes

multiline-blocks: for requireSingleLineUnderCount, ensure multi-line types nullify checks (#1422) (9b8efbd)

`v51.3.1`

Compare Source

Bug Fixes

no-undefined-types: check class and interface globals; fixes #1420 (#1421) (3748bbe)

`v51.3.0`

Compare Source

Features

multiline-blocks: adds requireSingleLineUnderCount option; fixes #1158 (#1409) (26276ba)

`v51.2.3`

Compare Source

Bug Fixes

require-template, no-undefined-types, valid-types: properly parse template tags with defaults; fixes #1418 (#1419) (35e95a1)

`v51.2.2`

Compare Source

Bug Fixes

no-undefined-types: exempt import tags from property checks; fixes #1416 (#1417) (efbcb1c)

`v51.2.1`

Compare Source

Bug Fixes

no-undefined-types: also allow globals defined on languageOptions (#1415) (e9ff4c7)

`v51.2.0`

Compare Source

Features

strip property when there is a class tag and the context is set (#1414) (08f7834), closes #1376

`v51.1.3`

Compare Source

Bug Fixes

no-undefined-types: liberalize checks to reallow for unknown properties on imports and defined globals; fixes #1412 (#1413) (a083c81)

`v51.1.2`

Compare Source

Bug Fixes

update jsdoccomment (#1411) (3d2d379)

`v51.1.1`

Compare Source

Bug Fixes

require-jsdoc: check interfaces within file for comment blocks; fixes #768 (#1410) (2875c2d)

`v51.1.0`

Compare Source

Features

lines-before-block: add default-on ignoreSingleLines option; fixes #1295 (#1408) (b0faae7)

`v51.0.7`

Compare Source

Bug Fixes

check-template-names: checks class body for comments where template names used; fixes #1354 (#1407) (ae2b314)

`v51.0.6`

Compare Source

Bug Fixes

require-jsdoc: update jsdoccomment (and espree) to get comment-finding for overloaded functions; fixes #1369 (#1406) (26ae169)

`v51.0.5`

Compare Source

Bug Fixes

no-undefined-types: check existence of class methods/properties (#1405) (fcc7b26)

`v51.0.4`

Compare Source

Bug Fixes

no-undefined-types: mark sister method and property names as defined; fixes #1403 ; fixes #1119 (#1404) (9bb554a)

`v51.0.3`

Compare Source

Bug Fixes

revert are-docs-informative while still using CJS; fixes #1400 (#1401) (ec387d6)

`v51.0.2`

Compare Source

Bug Fixes

revert "fix: require node v22"; fixes #1398 (#1402) (6855000)

`v51.0.1`

Compare Source

Bug Fixes

require node v22 (f85ffc6)

`v51.0.0`

Compare Source

chore

bump to Node 20.11.0+ (d45ad32)

BREAKING CHANGES

Requires Node 20.11.0+

Also:

chore: upgrade are-docs-informative
refactor: use import.meta.dirname

`v50.8.0`

Compare Source

Features

getJsdocProcessorPlugin: allow exampleCodeRegex and rejectExampleCodeRegex to be RegExp objects (#1395) (285a03c)

`v50.7.1`

Compare Source

Bug Fixes

revert are-docs-informative upgrade; fixes #1393 (#1394) (99cb131)

`v50.7.0`

Compare Source

Features

getJsdocProcessorPlugin: add allowedLanguagesToProcess option (#1392) (0adbf43)

`v50.6.17`

Compare Source

Bug Fixes

require-param: update jsdoccomment to support exported TSFunctionType type; fixes #1386 (#1389) (e26a11a)

`v50.6.16`

Compare Source

Bug Fixes

valid-types: fix parsing of expressions like [@returns](https://redirect.github.com/returns) {[@link](https://redirect.github.com/link) SomeType}; fixes #1381 (#1382) (2bd7242)

`v50.6.15`

Compare Source

Bug Fixes

no-undefined-types: avoid eslint 8 error; fixes #1387 (#1388) (1bef636)

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.