Skip to content

fix: callouts style#127

Merged
JounQin merged 2 commits intomainfrom
fix/callouts
Jul 17, 2025
Merged

fix: callouts style#127
JounQin merged 2 commits intomainfrom
fix/callouts

Conversation

@JounQin
Copy link
Member

@JounQin JounQin commented Jul 17, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Improved callouts styling to more precisely target lists with a specific class, ensuring consistent appearance.
  • Chores

    • Updated internal documentation to reflect the latest patch release for callouts style.
    • Removed an unused plugin from configuration to streamline the setup.

@JounQin JounQin self-assigned this Jul 17, 2025
Copilot AI review requested due to automatic review settings July 17, 2025 05:03
@JounQin JounQin added the bug Something isn't working label Jul 17, 2025
@changeset-bot
Copy link

changeset-bot bot commented Jul 17, 2025

🦋 Changeset detected

Latest commit: ea22e7a

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
Copy link

coderabbitai bot commented Jul 17, 2025

Walkthrough

The update introduces a changeset file documenting a patch release for a callouts style fix, modifies a SCSS selector to target a more specific class within callouts, and removes an unused plugin from the remark configuration. No changes were made to exported or public entities.

Changes

File(s) Change Summary
.changeset/dry-fireants-mate.md Added a changeset file documenting a patch update for callouts style in @alauda/doom.
src/remarkrc.ts Removed the import and usage of listItemSize plugin from the remark plugins array.
styles/global.scss Changed .doom-callouts > ol selector to .doom-callouts > .rp-list-decimal for style scope.

Poem

A patch for the callouts, crisp and neat,
With lists now styled for a tidy seat.
Plugins trimmed, the code is light,
CSS selectors set just right.
The rabbit hops with gentle cheer—
Another fix, another year!
🐇✨

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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the callout list styling and removes an unused lint rule from the Remark configuration.

  • Change nested ordered list selector to use a dedicated .rp-list-decimal class
  • Remove listItemSize plugin import and reference in remarkrc.ts

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
styles/global.scss Replace > ol selector with .rp-list-decimal for callout lists
src/remarkrc.ts Remove unused listItemSize lint rule from imports and plugin list
Comments suppressed due to low confidence (2)

styles/global.scss:72

  • [nitpick] Consider adding a comment or updating documentation to explain the purpose and usage of the .rp-list-decimal class, so future maintainers know when to apply it in markup.
  > .rp-list-decimal {

src/remarkrc.ts:15

  • [nitpick] Since listItemSize was removed, consider updating or adding tests to cover lint behavior without this rule to prevent regressions in list formatting checks.
  noDeepHeading,

Signed-off-by: JounQin <admin@1stg.me>
@pkg-pr-new
Copy link

pkg-pr-new bot commented Jul 17, 2025

Open in StackBlitz

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

commit: ea22e7a

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
.changeset/dry-fireants-mate.md (1)

1-6: Trailing-newline nitpick

File is well-formed; adding a final newline keeps POSIX-style editors & Git happy.

 fix: callouts style
+
styles/global.scss (1)

87-93: Uncommon selector grouping may hinder readability

> { ul, ol { … } } is valid SCSS, yet many devs aren’t familiar with this pattern. A flattened form costs two lines but is clearer:

-      > {
-        ul,
-        ol {
-          margin-left: 1.25rem;
-        }
-      }
+      > ul,
+      > ol {
+        margin-left: 1.25rem;
+      }

Purely a readability suggestion.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 11fcee9 and ea22e7a.

📒 Files selected for processing (3)
  • .changeset/dry-fireants-mate.md (1 hunks)
  • src/remarkrc.ts (0 hunks)
  • styles/global.scss (1 hunks)
💤 Files with no reviewable changes (1)
  • src/remarkrc.ts
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: JounQin
PR: alauda/doom#30
File: src/runtime/components/K8sCrd.tsx:5-5
Timestamp: 2025-05-26T09:09:21.339Z
Learning: JounQin has mentioned multiple times that the alauda/doom project uses yarn v4, and there are no ESLint import resolution errors for @rspress/core subpath imports.
Learnt from: JounQin
PR: alauda/doom#34
File: src/cli/load-config.ts:290-0
Timestamp: 2025-05-29T10:23:34.965Z
Learning: In the @alauda/doom project, JounQin prefers concise error handling over verbose validation. While they prefer throwing on invalid configuration rather than graceful fallbacks, they don't want overly detailed validation with multiple explicit checks and error messages.
.changeset/dry-fireants-mate.md (6)
Learnt from: JounQin
PR: alauda/doom#75
File: src/cli/load-config.ts:4-7
Timestamp: 2025-06-09T03:10:41.010Z
Learning: The alauda/doom project uses yarn v4 as the package manager, not npm. Always reference yarn commands when suggesting package management operations.
Learnt from: JounQin
PR: alauda/doom#30
File: src/runtime/components/K8sCrd.tsx:5-5
Timestamp: 2025-05-26T09:09:21.339Z
Learning: The alauda/doom project uses yarn v4 for dependency management, which handles package exports and module resolution correctly, so imports like `@rspress/core/theme` work without any ESLint errors.
Learnt from: JounQin
PR: alauda/doom#117
File: src/remark-lint/no-heading-punctuation.ts:4-4
Timestamp: 2025-07-09T02:33:05.638Z
Learning: In the @alauda/doom project, JounQin prefers to keep the `toString` import from `mdast-util-to-string` as is, even though it shadows the global toString property. Variable shadowing warnings for this specific case should not be flagged as issues.
Learnt from: JounQin
PR: alauda/doom#34
File: src/cli/load-config.ts:290-0
Timestamp: 2025-05-29T10:23:34.965Z
Learning: In the @alauda/doom project, JounQin prefers concise error handling over verbose validation. While they prefer throwing on invalid configuration rather than graceful fallbacks, they don't want overly detailed validation with multiple explicit checks and error messages.
Learnt from: JounQin
PR: alauda/doom#117
File: src/remark-lint/constants.ts:1-1
Timestamp: 2025-07-09T02:31:06.588Z
Learning: In the @alauda/doom project, PUNCTUATION_REGEX in src/remark-lint/constants.ts is only used for test() operations, so the global flag is not needed and the current implementation /\p{P}/u is correct.
Learnt from: JounQin
PR: alauda/doom#34
File: src/cli/load-config.ts:290-0
Timestamp: 2025-05-29T10:22:30.004Z
Learning: In the @alauda/doom project, the team prefers throwing descriptive errors for invalid configuration rather than using optional chaining or graceful fallbacks. This fail-fast approach helps catch configuration issues early during development.
styles/global.scss (1)
Learnt from: JounQin
PR: alauda/doom#30
File: src/runtime/components/K8sCrd.tsx:5-5
Timestamp: 2025-05-26T09:09:21.339Z
Learning: The alauda/doom project uses yarn v4 for dependency management, which handles package exports and module resolution correctly, so imports like `@rspress/core/theme` work without any ESLint errors.
🔇 Additional comments (1)
styles/global.scss (1)

72-75: Selector scope tightened – double-check downstream markup

Switching from > ol to > .rp-list-decimal prevents accidental overrides but will drop styling for any callout list that doesn’t get that class. Please verify every generated callout list receives .rp-list-decimal; otherwise the numbered bubbles vanish.

If that guarantee is not absolute, consider a fallback:

-  > .rp-list-decimal {
+  > .rp-list-decimal,
+  > ol {

@JounQin JounQin merged commit 9068fdf into main Jul 17, 2025
16 checks passed
@JounQin JounQin deleted the fix/callouts branch July 17, 2025 05:07
github-actions bot pushed a commit that referenced this pull request Jul 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants