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

Disable glsl compress for non-mini package #2469

Merged
merged 2 commits into from
Dec 18, 2024

Conversation

Sway007
Copy link
Member

@Sway007 Sway007 commented Dec 18, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

  • New Features

    • Introduced a new modular plugin for handling GLSL files, enhancing build configuration flexibility.
  • Bug Fixes

    • Improved clarity and management of plugin configurations based on build type and compression settings.

@Sway007 Sway007 added shader Shader related functions engineering Engineering problems high priority High priority issue labels Dec 18, 2024
@Sway007 Sway007 self-assigned this Dec 18, 2024
Copy link

coderabbitai bot commented Dec 18, 2024

Walkthrough

The pull request modifies the Rollup configuration by introducing a new glslifyPlugin that enhances the management of GLSL shader files. A separate instance for processing .glsl and .gs file types is created, allowing for conditional compression based on build settings. This refactoring streamlines the configuration, making the handling of shader-related plugins clearer and more modular.

Changes

File Change Summary
rollup.config.js - Added const glslifyPlugin for GLSL file processing
- Modified plugin configuration for conditional compression
- Improved handling of .glsl and .gs file extensions

Possibly related PRs

  • Migrate shader-shaderlab from engine-toolkit #2467: The changes in this PR involve the introduction of TypeScript declaration files for .glsl and .gs file types, which directly relates to the modifications made in the main PR regarding the handling of the glslify plugin for these file types in the Rollup configuration.

Suggested labels

Rendering, ignore for release

Suggested reviewers

  • GuoLei1990
  • hhhhkrx

Poem

🐰 In the Rollup garden, shaders bloom,
A plugin hops, dispelling gloom.
Compression toggles, a dance so bright,
GLSL files twirl in the build's soft light.
A rabbit's joy in each config's room! 🎨


📜 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 e348595 and 0810734.

📒 Files selected for processing (1)
  • rollup.config.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • rollup.config.js

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@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: 1

🧹 Nitpick comments (2)
rollup.config.js (2)

34-37: LGTM! Consider documenting the plugin configuration.

The base configuration for GLSL processing is well-structured and correctly disables compression by default.

Consider adding a comment explaining why compression is disabled by default and when it gets enabled.


Line range hint 34-104: Consider restructuring plugin configuration management.

The current implementation mixes build configuration with plugin configuration. Consider:

  1. Extract plugin configurations to a separate file (e.g., rollup.plugins.js)
  2. Create a factory function for glslify plugin configuration:
// rollup.plugins.js
function createGlslifyPlugin({ compress = false } = {}) {
  return glslify({
    include: [/\.(glsl|gs)$/],
    compress
  });
}

export const plugins = {
  base: createGlslifyPlugin(),
  compressed: createGlslifyPlugin({ compress: true })
};

This would make the configuration more maintainable and the compression settings more explicit.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 24abef3 and e348595.

📒 Files selected for processing (1)
  • rollup.config.js (2 hunks)
🔇 Additional comments (1)
rollup.config.js (1)

41-41: LGTM! Plugin placement is correct.

The glslifyPlugin is appropriately positioned in the plugin chain, ensuring shader processing occurs before transpilation.

rollup.config.js Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.70%. Comparing base (24abef3) to head (0810734).
Report is 40 commits behind head on dev/1.4.

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.4    #2469      +/-   ##
===========================================
- Coverage    68.27%   67.70%   -0.58%     
===========================================
  Files          911      911              
  Lines        94585    94514      -71     
  Branches      7937     7942       +5     
===========================================
- Hits         64582    63992     -590     
- Misses       29752    30270     +518     
- Partials       251      252       +1     
Flag Coverage Δ
unittests 67.70% <ø> (-0.58%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@GuoLei1990 GuoLei1990 merged commit aa07cd8 into galacean:dev/1.4 Dec 18, 2024
7 checks passed
@GuoLei1990 GuoLei1990 added the ignore for release ignore for release label Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Engineering problems high priority High priority issue ignore for release ignore for release shader Shader related functions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants