fix: unknown node type raw for mdx

[JounQin]

Summary by CodeRabbit

• New Features

  • Added release notes pages for version 4.0.1 in both English and Chinese, including sections for fixed and known issues.
  • Introduced new query templates to dynamically display fixed and known issues for version 4.0.1 in release notes.

• Bug Fixes

  • Improved handling of line breaks in release notes to ensure correct formatting in MDX documents.

• Chores

  • Updated several dependencies to their latest versions.
  • Added a changelog entry documenting a patch update.

[changeset-bot]

🦋 Changeset detected

Latest commit: 80ab89c

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]

Warning

Rate limit exceeded

@JounQin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between bfd07ff and 80ab89c.

⛔ Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (3)

• .changeset/empty-crews-jog.md (1 hunks)
• package.json (4 hunks)
• src/plugins/replace/resolve-release.ts (5 hunks)

Walkthrough

This update introduces new release notes documentation in both English and Chinese, adds query templates for release notes filtering, and updates several package dependencies. The MDX processing logic is modified to conditionally render line breaks as either HTML or MDX JSX elements, controlled by a new isMdx parameter passed through relevant functions.

Changes

Files/Paths	Change Summary
.changeset/empty-crews-jog.md	Added changeset documenting patch for handling unknown raw node type in MDX.
fixture-docs/en/release_notes.mdx, fixture-docs/zh/release_notes.mdx	Added new release notes markdown files with dynamic sections for fixed and known issues for version 4.0.1.
fixture-docs/doom.config.yml	Added acp_fixed_4.0.1 and acp_known_issues_4.0.1 query templates for release notes.
package.json	Updated versions of several dependencies (@rsbuild/plugin-sass, @shikijs/transformers, shiki, etc.).
src/plugins/replace/remark-replace.ts	Passed new isMdx argument to resolveRelease for MDX-aware processing.
src/plugins/replace/resolve-release.ts	Updated function signatures and logic to handle line breaks differently based on isMdx argument.

Sequence Diagram(s)

sequenceDiagram
    participant MDXDoc as MDX Document
    participant RemarkReplace as remarkReplace Plugin
    participant ResolveRelease as resolveRelease Function

    MDXDoc->>RemarkReplace: Process release notes template
    RemarkReplace->>ResolveRelease: resolveRelease(templates, query, lang, isMdx)
    ResolveRelease->>ResolveRelease: issuesToListItems(issues, lang, isMdx)
    ResolveRelease-->>RemarkReplace: List items with <br> as JSX or HTML
    RemarkReplace-->>MDXDoc: Rendered release notes section

Loading

Possibly related PRs

• alauda/doom#45: Removes the rehype-raw plugin and related fixes, directly affecting how raw HTML nodes are processed in MDX, which is closely related to the handling of raw nodes addressed in this PR.

Suggested labels

documentation

Poem

A bunny hops through docs anew,
With notes in English, 中文 too!
Line breaks now are smart and keen,
MDX or HTML—so clean.
Packages fresh, the changelog grows,
In every burrow, knowledge flows!
🐇✨

✨ 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.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@alauda/doom@63

commit: 80ab89c