Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: remove vite-plugin-lib-inject-css #4793

Merged
merged 1 commit into from
Nov 2, 2024
Merged

fix: remove vite-plugin-lib-inject-css #4793

merged 1 commit into from
Nov 2, 2024

Conversation

anncwb
Copy link
Collaborator

@anncwb anncwb commented Nov 2, 2024

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Updated the primary export for the @vben-core/design package to point to the CSS file, making it the main entry point.
  • Bug Fixes

    • Removed the unused vite-plugin-lib-inject-css dependency from various configurations, streamlining the build process.
  • Documentation

    • Updated the pnpm-workspace.yaml to reflect the removal of the vite-plugin-lib-inject-css entry from the catalog.

@anncwb anncwb requested review from vince292007 and a team as code owners November 2, 2024 07:22
Copy link

changeset-bot bot commented Nov 2, 2024

⚠️ No Changeset found

Latest commit: 0d9a184

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

coderabbitai bot commented Nov 2, 2024

Walkthrough

This pull request introduces several changes across multiple files, primarily focusing on the removal of the vite-plugin-lib-inject-css dependency and related configurations. Notably, the COMPATIBILITY_DATE environment variable is set in the Nitro configuration file. The package.json for @vben/vite-config and @vben-core/design packages are updated, with the latter changing its default export to a CSS file. The LibraryPluginOptions interface is also modified to remove the injectLibCss property, streamlining the plugin handling process.

Changes

File Path Change Summary
apps/backend-mock/nitro.config.ts Added a line to set COMPATIBILITY_DATE to the current date in ISO format.
internal/vite-config/package.json Removed dependency "vite-plugin-lib-inject-css": "catalog:".
internal/vite-config/src/config/library.ts Removed injectLibCss property from options in defineLibraryConfig.
internal/vite-config/src/plugins/index.ts Removed import of viteLibInjectCss and adjusted destructuring in loadLibraryPlugins.
internal/vite-config/src/typing.ts Removed injectLibCss property from LibraryPluginOptions interface.
packages/@core/base/design/package.json Changed default export from "./dist/index.mjs" to "./dist/style.css" in exports section.
pnpm-workspace.yaml Removed vite-plugin-lib-inject-css: ^2.1.1 from the catalog section.

Possibly related PRs

Suggested labels

chore

Suggested reviewers

  • vince292007

🐇 In the code, I've hopped and played,
A date for compatibility, I've laid.
CSS no longer injected with flair,
A simpler path, light as air.
With plugins trimmed, we leap and bound,
In our code garden, joy is found! 🌼


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.

Copy link
Contributor

@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

🧹 Outside diff range and nitpick comments (2)
packages/@core/base/design/package.json (1)

31-31: Resolve inconsistency between runtime and publish exports

There's an inconsistency between the runtime exports (pointing to CSS) and publish exports (pointing to JS). This dual configuration could lead to confusion and potential issues:

  • Runtime: "default": "./dist/style.css"
  • Publish: "default": "./dist/index.mjs"

Consider:

  1. Aligning both configurations to use the same export
  2. Documenting the reasoning behind this dual configuration if it's intentional
  3. Providing clear migration guidelines for package consumers

Also applies to: 34-40

internal/vite-config/src/plugins/index.ts (1)

226-235: Clean plugin architecture maintained.

The plugin system's modular design made this removal straightforward. The conditional plugin loading pattern continues to provide good separation of concerns and flexibility.

Consider documenting this plugin system architecture in the project's technical documentation, as it provides a great example of extensible plugin management.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between faf18d0 and 0d9a184.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (7)
  • apps/backend-mock/nitro.config.ts (1 hunks)
  • internal/vite-config/package.json (0 hunks)
  • internal/vite-config/src/config/library.ts (0 hunks)
  • internal/vite-config/src/plugins/index.ts (1 hunks)
  • internal/vite-config/src/typing.ts (0 hunks)
  • packages/@core/base/design/package.json (1 hunks)
  • pnpm-workspace.yaml (0 hunks)
💤 Files with no reviewable changes (4)
  • internal/vite-config/package.json
  • internal/vite-config/src/config/library.ts
  • internal/vite-config/src/typing.ts
  • pnpm-workspace.yaml
✅ Files skipped from review due to trivial changes (1)
  • apps/backend-mock/nitro.config.ts
🔇 Additional comments (2)
packages/@core/base/design/package.json (1)

31-31: ⚠️ Breaking Change: Default export changed to CSS file

This change modifies the default export from a JavaScript module to a CSS file, which is a breaking change that could affect package consumers.

Let's verify the impact of this change:

✅ Verification successful

✅ Default export change to CSS is intentional and safe

Based on the documentation and usage patterns found:

  • The package is primarily used for providing styles, as shown in the documentation
  • Current imports are simple style imports (import '@vben-core/design')
  • The package maintains backward compatibility through publishConfig
  • This change aligns with the documented purpose of the package for styling
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for direct imports of @vben-core/design to identify affected code
rg -l '@vben-core/design['"'"'"]' --type ts --type vue

# Check if there are any style imports that might conflict
rg -l '@vben-core/design/.*style' --type ts --type vue

Length of output: 168


Script:

#!/bin/bash
# Search for direct imports using ripgrep without file type restrictions
rg -l '@vben-core/design'

# Check package.json to understand the full export configuration
cat "packages/@core/base/design/package.json"

# Look for any documentation about this package's usage
fd "README" packages/@core/base/design

Length of output: 1344


Script:

#!/bin/bash
# Check the content of files that import this package to understand usage patterns
cat "packages/styles/src/index.ts"
cat "packages/styles/README.md"
cat "docs/src/guide/essentials/styles.md"

# Look for any migration guides or documentation about this change
rg -l "vite-plugin-lib-inject-css" 

Length of output: 2266

internal/vite-config/src/plugins/index.ts (1)

227-227: LGTM! Verify documentation and migration steps.

The removal of injectLibCss from options destructuring is clean and aligns with the PR objective to remove vite-plugin-lib-inject-css.

Let's verify the documentation and potential breaking changes:

✅ Verification successful

Let me gather more information about the plugin removal by checking the package dependencies and configuration files.


Clean removal of vite-plugin-lib-inject-css confirmed

The removal of injectLibCss option is complete and clean. No remaining references were found in:

  • Package dependencies
  • Configuration files
  • TypeScript interfaces
  • Documentation (only general CSS-related content found)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any remaining references to the removed plugin in docs and configs
echo "Checking for remaining references to vite-plugin-lib-inject-css..."
rg -i "vite-plugin-lib-inject-css|injectLibCss"

# Look for potential migration guides or documentation that needs updating
echo "Checking documentation files..."
fd -e md -e mdx | xargs rg -i "css.*(inject|plugin)"

Length of output: 1059


Script:

#!/bin/bash
# Check package.json for any remaining dependencies
echo "Checking package.json files..."
fd package.json | xargs rg -i "vite-plugin-lib-inject-css"

# Check vite config files for any remaining configurations
echo "Checking vite config files..."
fd -e ts -e js | xargs rg -i "injectLibCss|libInjectCss" -A 2 -B 2

# Check for any TypeScript interfaces or types related to the removed option
echo "Checking TypeScript definitions..."
ast-grep --pattern 'interface $_ {
  $$$
  injectLibCss?: $_
  $$$
}'

Length of output: 418

@anncwb anncwb merged commit 43d95cc into main Nov 2, 2024
14 checks passed
@anncwb anncwb deleted the bugfix/4783-1 branch November 2, 2024 07:30
GavinLucky pushed a commit to GavinLucky/vue-vben-admin that referenced this pull request Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant