build(deps-dev): bump eslint-plugin-jsdoc from 39.9.1 to 50.2.3

[dependabot]

Bumps eslint-plugin-jsdoc from 39.9.1 to 50.2.3.

Release notes

Sourced from eslint-plugin-jsdoc's releases.

v50.2.3

50.2.3 (2024-09-13)

Bug Fixes

• require-jsdoc: avoid erring on static blocks (8222262)

v50.2.2

50.2.2 (2024-08-14)

Bug Fixes

• check-param-names: check against whitelist of acceptable function nodes so that non-function global contexts do not err; fixes #1303 (288f0ae)

v50.2.1

50.2.1 (2024-08-13)

Bug Fixes

• properly include options in ruleset factories (964712b)

v50.2.0

50.2.0 (2024-08-13)

Features

• added granular flat TypeScript configs (#1298) (aed3194)

v50.1.0

50.1.0 (2024-08-13)

Features

• update jsdoccomment, debug, devDeps.; fixes #1304 (75528b7)

v50.0.1

50.0.1 (2024-08-11)

Bug Fixes

• no-bad-blocks: exclude ESLint directives (df55137)

v50.0.0

50.0.0 (2024-08-07)

... (truncated)

Commits

• 8222262 fix(require-jsdoc): avoid erring on static blocks
• 288f0ae fix(check-param-names): check against whitelist of acceptable function node...
• b039833 docs(text-escaping): indicate defaults for escapeHTML
• 964712b fix: properly include options in ruleset factories
• aed3194 feat: added granular flat TypeScript configs (#1298)
• 6e82aeb docs: mark lines-before-block as not currently recommended
• 75528b7 feat: update jsdoccomment, debug, devDeps.; fixes #1304
• df55137 fix(no-bad-blocks): exclude ESLint directives
• 1cae2cb fix(lines-before-block): remove rule from recommended
• 0265923 feat(lines-before-block): add new rule; fixes #1209
• Additional commits viewable in compare view

Most Recent Ignore Conditions Applied to This Pull Request

Dependency Name	Ignore Conditions
eslint-plugin-jsdoc	[>= 43.a, < 44]
eslint-plugin-jsdoc	[>= 46.a, < 47]
eslint-plugin-jsdoc	[>= 45.a, < 46]
eslint-plugin-jsdoc	[>= 44.a, < 45]
eslint-plugin-jsdoc	[>= 48.a, < 49]

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Summary by CodeRabbit

• Chores
  • Upgraded the eslint-plugin-jsdoc dependency to a newer major version, which may enhance linting rules and behaviors for JSDoc comments.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	filesystem Transitive: environment	+16	4.78 MB	gajus

🚮 Removed packages: npm/[email protected]

View full report↗︎

[justinr1234]

@CodeRabbit full review

[justinr1234]

@coderabbitai full review

[coderabbitai]

Actions performed

Full review triggered.

[coderabbitai]

Walkthrough

The pull request updates the version of the eslint-plugin-jsdoc dependency in the package.json file from ^39.3.3 to ^50.2.3. This change signifies an upgrade to a newer major version, which may introduce new features, improvements, and potential breaking changes. Consequently, it is essential to review the project's documentation practices to ensure alignment with the updated plugin's requirements.

Changes

Files	Change Summary
package.json	Updated eslint-plugin-jsdoc version from ^39.3.3 to ^50.2.3

Assessment against linked issues

Objective	Addressed	Explanation
Get total transaction count without iteration (#1303)	❌	The changes do not address the transaction count issue.
Ensure data consistency in transaction events (#1304)	❌	The changes do not resolve the data consistency problem.
Fix error in generateXAddress function (#1209)	❌	The changes do not address the error in the function.

Poem

🐇 In the code where rabbits play,
A plugin's version leaps today!
From thirty-nine to fifty's cheer,
With linting rules now crystal clear.
Hop along, let changes flow,
In our code, let harmony grow! 🌟

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f3960c3 and c0eb73b.

Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

Files selected for processing (1)

• package.json (1 hunks)

Additional comments not posted (1)

package.json (1)

41-41: Verify the impact of the major version update on the project's JSDoc linting rules and documentation practices.

The update to eslint-plugin-jsdoc version 50.2.3 includes several bug fixes and enhancements that could improve the accuracy and reliability of JSDoc linting in the project. However, the major version bump from 39.x.x to 50.x.x could also introduce breaking changes.

To ensure a smooth transition, consider the following:

1. Review the project's JSDoc linting rules and configurations to identify any potential incompatibilities or necessary adjustments due to the updated plugin version.

2. Verify that the project's documentation practices align with the requirements and best practices enforced by the new version of eslint-plugin-jsdoc.

3. Run the following script to analyze the impact of the updated plugin on the project's JSDoc linting:

4. Address any identified issues or incompatibilities to ensure the project maintains consistent and accurate JSDoc documentation.

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[dependabot]

Superseded by #2783.