fix: use prettierRcOptions directly for prettier 3.6+

[JounQin]

related hosseinmd/prettier-plugin-jsdoc#245

Important

Directly use prettierRcOptions in worker.mjs and update Prettier to 3.6.1, removing prettier-plugin-jsdoc.

• Behavior:
  • In worker.mjs, directly uses prettierRcOptions instead of extracting plugins manually.
  • Updates Prettier version to ^3.6.1 in package.json.
• Configuration:
  • Removes prettier-plugin-jsdoc from .prettierrc and package.json.

^{This description was created by for 95724c3. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

• Chores
  • Updated Prettier to version 3.6.1 and improved compatibility handling.
  • Removed the "prettier-plugin-jsdoc" dependency and plugin configuration.
• Documentation
  • Cleaned up extra blank lines in the README for improved readability.

[changeset-bot]

🦋 Changeset detected

Latest commit: 7577d67

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
eslint-plugin-prettier	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Walkthrough

This update removes the prettier-plugin-jsdoc plugin from both the Prettier configuration and development dependencies, updates the Prettier version override to ^3.6.1, and adjusts how Prettier configuration options are passed in the worker script. Minor whitespace cleanup is also applied to the README documentation.

Changes

File(s)	Change Summary
.changeset/shiny-bears-turn.md	Added a changeset describing a patch update for compatibility with Prettier v3.6+.
.prettierrc, package.json	Removed prettier-plugin-jsdoc from plugins and devDependencies; updated Prettier override to 3.6.1.
worker.mjs	Now spreads all prettierRcOptions into prettier.getFileInfo instead of just the plugins field.
README.md	Cleaned up extraneous blank lines in the "Options" section.

Poem

A whisk of code, a plugin gone,
Prettier shines as it moves on.
Jsdoc departs with gentle cheer,
New configs spread from far to near.
With whitespace trimmed and docs anew,
This patch brings harmony—thank you!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c4b792 and 7577d67.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (5)

• .changeset/shiny-bears-turn.md (1 hunks)
• .prettierrc (0 hunks)
• README.md (0 hunks)
• package.json (1 hunks)
• worker.mjs (1 hunks)

💤 Files with no reviewable changes (2)

• .prettierrc
• README.md

🔇 Additional comments (2)

package.json (1)

107-107: LGTM - Version update aligns with PR objectives.

The prettier version override update to ^3.6.1 properly supports the new prettier 3.6+ configuration handling mentioned in the PR objectives.

.changeset/shiny-bears-turn.md (1)

1-6: LGTM - Changeset properly documents the fix.

The changeset correctly identifies this as a patch-level fix and accurately describes the change for prettier 3.6+ compatibility.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[Copilot]

Pull Request Overview

The PR updates the configuration for Prettier usage to support version 3.6+ by using the prettierRcOptions directly instead of extracting only the plugins, and it removes the now unnecessary prettier-plugin-jsdoc.

• In worker.mjs, spread operator is used to directly incorporate prettierRcOptions.
• In package.json and .prettierrc, prettier-plugin-jsdoc is removed and the Prettier version is updated.

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File	Description
worker.mjs	Update to directly spread prettierRcOptions in worker configuration.
package.json	Prettier version bumped and prettier-plugin-jsdoc removed.
.prettierrc	Removal of prettier-plugin-jsdoc from Prettier configuration.

Files not reviewed (1)

• pnpm-lock.yaml: Language not supported

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/eslint-plugin-prettier@748

commit: 7577d67

[ellipsis-dev]

Caution

Changes requested ❌

Reviewed everything up to 95724c3 in 1 minute and 48 seconds. Click for details.

• Reviewed 48 lines of code in 3 files
• Skipped 1 files when reviewing.
• Skipped posting 3 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. .prettierrc:6

• Draft comment:
  Removed 'prettier-plugin-jsdoc' from the plugins array. Confirm this removal is intentional and update docs if needed.
• Reason this comment was not posted:
  Comment looked like it was already resolved.

2. package.json:93

• Draft comment:
  Removed dependency 'prettier-plugin-jsdoc'. Ensure that dropping this dependency doesn’t affect jsdoc formatting if it's needed.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% The comment is about a dependency change, specifically the removal of a dependency. The rules state not to comment on pure dependency changes or anything related to dependencies. This comment is asking the author to ensure that the removal doesn't affect functionality, which is against the rules.

3. package.json:105

• Draft comment:
  Prettier override updated to '^3.6.1'. Verify that this update is fully compatible with the project configuration.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is asking the PR author to verify compatibility of a dependency update, which is against the rules. It does not provide a specific suggestion or point out a specific issue with the code.

Workflow ID: wflow_8aWk6NQlNFCg0UQa

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}