Rename package name fo `engine-shader-lab` to `engine-shaderlab` #2484

Sway007 · 2025-01-02T09:52:25Z

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)

Summary by CodeRabbit

Chores
- Renamed package from @galacean/engine-shader-lab to @galacean/engine-shaderlab
- Updated import paths across multiple files to reflect the new package name
- Modified package configuration files to use the new package name

coderabbitai · 2025-01-02T09:52:32Z

Walkthrough

This pull request involves a comprehensive package renaming from @galacean/engine-shader-lab to @galacean/engine-shaderlab. The changes span multiple files across the project, including package configurations, import statements, README documentation, and test files. The renaming is consistent across different parts of the codebase, ensuring that all references to the package are updated to reflect the new name.

Changes

File	Change Summary
`e2e/package.json`	Dependency renamed from `@galacean/engine-shader-lab` to `@galacean/engine-shaderlab`
`packages/core/src/shader/Shader.ts`	Import path updated for `ShaderLab` module
`packages/shader-lab/README.md`	Updated package name in installation instructions and import statements
`packages/shader-lab/package.json`	Package name changed from `@galacean/engine-shader-lab` to `@galacean/engine-shaderlab`
`rollup.config.js`	Updated package name search in configuration
`tests/package.json`	Dependency renamed from `@galacean/engine-shader-lab` to `@galacean/engine-shaderlab`
`tests/src/*`	Multiple test files updated with new import paths

Possibly related PRs

ShaderLab ignore Editor module #2395: Renaming of @galacean/engine-shader-lab package
Replace unit test framework from floss to vitest #2396: Updating import statements for the renamed package
Opt ShaderLab module code #2419: Modifications to ShaderContentParser class
Fix shaderlab loader in NPM mode #2427: Shader loader fixes
Migrate shader-shaderlab from engine-toolkit #2467: Migration of shader-related components
Disable glsl compress for non-mini package #2469: Rollup configuration changes for GLSL files

Suggested Labels

medium priority, ignore for release

Suggested Reviewers

GuoLei1990
zhuxudong

Poem

🐰 A Shader's New Name

From lab to lab, a package takes flight,
Renaming itself with algorithmic might.
ShaderLab whispers, "I'm the same inside,"
With imports updated, it takes new stride.
A rabbit's cheer for code's gentle dance! 🎉

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.

coderabbitai

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 70af4ee and 0d367c3.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (10)

e2e/package.json (1 hunks)
packages/core/src/shader/Shader.ts (1 hunks)
packages/shader-lab/README.md (2 hunks)
packages/shader-lab/package.json (1 hunks)
rollup.config.js (1 hunks)
tests/package.json (1 hunks)
tests/src/core/Shader.test.ts (1 hunks)
tests/src/shader-lab/Preprocessor.test.ts (1 hunks)
tests/src/shader-lab/ShaderLab.test.ts (1 hunks)
tests/src/shader-lab/ShaderValidate.ts (1 hunks)

✅ Files skipped from review due to trivial changes (9)

tests/package.json
packages/shader-lab/package.json
e2e/package.json
packages/core/src/shader/Shader.ts
tests/src/core/Shader.test.ts
tests/src/shader-lab/ShaderValidate.ts
tests/src/shader-lab/ShaderLab.test.ts
tests/src/shader-lab/Preprocessor.test.ts
packages/shader-lab/README.md

coderabbitai · 2025-01-02T09:54:34Z

rollup.config.js

@@ -24,7 +24,7 @@ const pkgs = fs
    };
  });

-const shaderLabPkg = pkgs.find((item) => item.pkgJson.name === "@galacean/engine-shader-lab");
+const shaderLabPkg = pkgs.find((item) => item.pkgJson.name === "@galacean/engine-shaderlab");


💡 Codebase verification

Update imports and documentation to use the new package name @galacean/engine-shaderlab

Several files still reference the old package name @galacean/engine-shader-lab:

Import statements in example files:

examples/shader-water.ts

examples/shader-lab-multi-pass.ts

examples/shader-lab-simple.ts

examples/shader-lab.ts

examples/buffer-mesh-particle-shader-effect.ts

Import statements in e2e test files:

e2e/case/material-shaderLab.ts

e2e/case/shaderLab-renderState.ts

e2e/case/project-loader.ts

e2e/case/shaderLab-mrt.ts

Documentation references:

docs/en/basics/overview.md

docs/zh/basics/overview.md

🔗 Analysis chain

Ensure all references have been updated consistently.

The package name has been changed from @galacean/engine-shader-lab to @galacean/engine-shaderlab. This looks correct; however, please verify that no references to the old name remain in the codebase.

Use this script to spot-check any residual references to the old name:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash # Search for any lingering references to '@galacean/engine-shader-lab' to ensure all have been updated. rg '@galacean/engine-shader-lab'

Length of output: 1197

codecov · 2025-01-02T09:55:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.40%. Comparing base (980a7ed) to head (0d367c3).
Report is 18 commits behind head on dev/1.4.

Additional details and impacted files

@@             Coverage Diff             @@
##           dev/1.4    #2484      +/-   ##
===========================================
- Coverage    68.86%   68.40%   -0.46%     
===========================================
  Files          923      923              
  Lines        95894    95904      +10     
  Branches      8133     8137       +4     
===========================================
- Hits         66038    65606     -432     
- Misses       29602    30044     +442     
  Partials       254      254

Flag	Coverage Δ
unittests	`68.40% <100.00%> (-0.46%)`	⬇️

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.

Sway007 added 5 commits December 18, 2024 15:17

feat: disable glsl compress for non mini package

e348595

Merge branch 'dev/1.4' of github.com:galacean/engine into dev/1.4

6c99773

Merge branch 'dev/1.4' of github.com:galacean/engine into dev/1.4

bc17b5e

Merge branch 'dev/1.4' of github.com:galacean/engine into dev/1.4

b80c07d

chore: rename engine-shader-lab to engine-shaderlab

0d367c3

Sway007 added shader Shader related functions engineering Engineering problems compatibility risk There may be a certain compatibility risk, which needs to be verified by real machine testing labels Jan 2, 2025

Sway007 requested review from GuoLei1990 and zhuxudong January 2, 2025 09:52

Sway007 self-assigned this Jan 2, 2025

coderabbitai bot reviewed Jan 2, 2025

View reviewed changes

GuoLei1990 merged commit 71244d9 into galacean:dev/1.4 Jan 2, 2025
7 of 9 checks passed

This was referenced Jan 3, 2025

Refactor AST code in ShaderLab for performance #2486

Open

Fix ci e2e error #2492

Merged

GuoLei1990 added the ignore for release ignore for release label Jan 8, 2025

coderabbitai bot mentioned this pull request Jan 8, 2025

Fix generic type deduce bug of ShaderLab compiler in verbose mode #2477

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename package name fo `engine-shader-lab` to `engine-shaderlab` #2484

Rename package name fo `engine-shader-lab` to `engine-shaderlab` #2484

Sway007 commented Jan 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 2, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Jan 2, 2025

codecov bot commented Jan 2, 2025 •

edited

Loading

Rename package name fo engine-shader-lab to engine-shaderlab #2484

Rename package name fo engine-shader-lab to engine-shaderlab #2484

Conversation

Sway007 commented Jan 2, 2025 • edited by coderabbitai bot Loading

Please check if the PR fulfills these requirements

Summary by CodeRabbit

coderabbitai bot commented Jan 2, 2025 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested Labels

Suggested Reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Jan 2, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 2, 2025 • edited Loading

Codecov Report

Rename package name fo `engine-shader-lab` to `engine-shaderlab` #2484

Rename package name fo `engine-shader-lab` to `engine-shaderlab` #2484

Sway007 commented Jan 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jan 2, 2025 •

edited

Loading