Skip to content

fix: add style import to bundle#838

Merged
hexqi merged 1 commit intoopentiny:refactor/developfrom
chilingling:fix/baseThemeBuildStyle
Sep 30, 2024
Merged

fix: add style import to bundle#838
hexqi merged 1 commit intoopentiny:refactor/developfrom
chilingling:fix/baseThemeBuildStyle

Conversation

@chilingling
Copy link
Copy Markdown
Member

@chilingling chilingling commented Sep 30, 2024

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Enhanced build process to include a CSS file in the output, improving style application in the resulting library.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 30, 2024

Walkthrough

The changes in this pull request focus on updating the vite.config.js file to enhance the build configuration. A new rollupOptions section has been added under the build configuration, which introduces an output property that includes a banner option. This option specifies the inclusion of a CSS file, ensuring it is part of the output during the build process.

Changes

File Change Summary
packages/theme/base/vite.config.js Added rollupOptions to the build configuration, introducing an output property with a banner option to include a CSS file.

Possibly related PRs

Suggested labels

ready_for_review

Poem

In the meadow where bunnies play,
A new config brightens the day.
With CSS wrapped in a banner's embrace,
Our styles will dance with elegance and grace.
Hopping along, we cheer with delight,
For a build that's now just right! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ff3695a and fca6da6.

📒 Files selected for processing (1)
  • packages/theme/base/vite.config.js (1 hunks)
🔇 Additional comments (1)
packages/theme/base/vite.config.js (1)

25-29: LGTM! Consider dynamic import and file existence check.

The addition of rollupOptions to import the CSS file in the bundle aligns well with the PR objective. This change should effectively solve the issue of including style imports in the build bundle.

However, consider the following improvements:

  1. Use a dynamic import to make the path more flexible and maintainable.
  2. Add a build-time check for the existence of the CSS file to prevent potential runtime errors.

Here's a suggested improvement:

 build: {
   lib: {
     entry: path.resolve(__dirname, './src/index.js'),
     name: 'theme-base',
     fileName: () => 'index.js',
     formats: ['es']
   },
   rollupOptions: {
     output: {
-      banner: 'import "./style.css"'
+      banner: `import.meta.url.replace(/\.js$/, '.css')`
     }
   }
 }

To ensure the CSS file exists and the import works as expected, run the following script:


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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.

@chilingling chilingling added bug Something isn't working ready_for_review This PR requires more reviews labels Sep 30, 2024
@hexqi hexqi merged commit 6f9ab48 into opentiny:refactor/develop Sep 30, 2024
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
@coderabbitai coderabbitai Bot mentioned this pull request Dec 3, 2024
14 tasks
@chilingling chilingling deleted the fix/baseThemeBuildStyle branch February 27, 2026 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working ready_for_review This PR requires more reviews

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants