fix: rspress built-in container directives

[JounQin]

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of container directives like tips, notes, warnings, and info to prevent unnecessary processing, enhancing the accuracy of directive block rendering.

[changeset-bot]

🦋 Changeset detected

Latest commit: eaf0683

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

This PR includes changesets to release 1 package

Name	Type
@alauda/doom	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

A constant set of container directive types was added to the code. The visitor function now returns early for nodes matching these types or with a specific class prefix, skipping further processing for these directives. No changes were made to exported or public entity signatures.

Changes

File(s)	Change Summary
src/plugins/directives/remark-directives.ts	Added a constant set for container directive types; updated visitor function with early return logic
.changeset/shaggy-crabs-pretend.md	Added changeset documenting a patch fix for rspress built-in container directives

Estimated code review effort

2 (~15 minutes)

Possibly related PRs

• fix: render unsupported directives as text #136: Modifies the visitor logic in the same file by converting unknown directives to markdown text, complementing this PR’s handling of known container directives with early return.

Poem

In the code a rabbit hopped today,
Sorting directives in a clever way.
"Tip" and "note" now skip the queue,
With "danger" and "info" hopping through.
Early returns keep things neat,
Making the plugin fast on its feet!
🐇✨

---

📜 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 af1f513 and eaf0683.

📒 Files selected for processing (1)

• .changeset/shaggy-crabs-pretend.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .changeset/shaggy-crabs-pretend.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)

• GitHub Check: Build and Lint with Node.js 20 on ubuntu-latest
• GitHub Check: Build and Lint with Node.js 24 on ubuntu-latest
• GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest
• GitHub Check: Build and Lint with Node.js 22 on ubuntu-latest
• GitHub Check: Build and Lint with Node.js 20 on ubuntu-latest
• GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest
• GitHub Check: Build and Lint with Node.js 22 on ubuntu-latest
• GitHub Check: Build and Lint with Node.js 24 on ubuntu-latest

---

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

This PR fixes container directive handling by preventing certain container types from being processed by the general directive switch statement. The change ensures that standard container directive types (tip, note, warning, etc.) and rspress-directive containers are handled by their default behavior rather than falling through to custom processing logic.

• Adds a constant set of standard container directive types that should be excluded from custom processing
• Implements an early return condition to skip processing for these container types and rspress-directive containers

[pkg-pr-new]

Open in StackBlitz

yarn add https://pkg.pr.new/@alauda/doom@138.tgz

commit: eaf0683