search

galacean / engine

A typescript interactive engine, support 2D, 3D, animation, physics, built on WebGL and glTF.
https://www.galacean.com/engine
MIT License
4.29k stars 307 forks source link

ShaderLab ignore `Editor` module #2395

Closed Sway007 closed 1 week ago

Sway007 commented 1 month ago

Please check if the PR fulfills these requirements

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

related editor issue galacean/editor#2877

  1. ShaderLab compiler ignore Editor module like below 

    Shader "Unlit" {
...
Editor {
        Properties {
          /**
           * @language zh
           * 主颜色
          */

          /**
          * @language en
          * Main Color
          */
          material_BaseColor("Main Color", Color) = (0, 0, 0, 1);
          material_AlphaCutoff("Alpha Cutoff", Range(0, 1, 0.01)) = 0;
          material_BaseTexture("Texture", Texture2D);
        }

        Macros {
          Header("Conditional Macors") {
            MATERIAL_HAS_BASETEXTURE("Base Texture");
            MATERIAL_IS_ALPHA_CUTOFF("Alpha Cutoff");
          }
        }

        UIScript "${params.uiScriptPath}";
      }
...
}

  2. Fix RenderQueueType variable assignment bug in ShaderLab

    // renderQueueType is a variable evaluea
RenderQueueType = renderQueueType;

  3. Remove duplicate code skip process.

Editor block code skip process is performed in ShaderContentParser and PpParser

Summary by CodeRabbit

Release Notes

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 61.53846% with 10 lines in your changes missing coverage. Please review.

Project coverage is 66.88%. Comparing base (14027ac) to head (2749c76). Report is 1 commits behind head on dev/1.4.

Files with missing lines Patch % Lines
...hader-lab/src/contentParser/ShaderContentParser.ts 60.00% 4 Missing :warning:
packages/shader-lab/src/ShaderLab.ts 33.33% 2 Missing :warning:
...ckages/shader-lab/src/parser/ShaderTargetParser.ts 33.33% 2 Missing :warning:
packages/shader-lab/src/preprocessor/PpParser.ts 0.00% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev/1.4 #2395 +/- ## =========================================== + Coverage 66.84% 66.88% +0.04% =========================================== Files 897 897 Lines 92617 92597 -20 Branches 7341 7347 +6 =========================================== + Hits 61906 61930 +24 + Misses 30465 30421 -44 Partials 246 246 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2395/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/galacean/engine/pull/2395/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `66.88% <61.53%> (+0.04%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve the addition of a new keyword GS_Editor to the EKeyword enum in Keywords.ts, and its corresponding mapping in KeywordMap.ts. The shader parsing logic in ShaderContentParser.ts has been updated to handle this new keyword. Additionally, various error handling mechanisms across several files have been modified to improve robustness and type safety, including changes in error reporting and logging in the ShaderLab class and related utility classes.

Changes

File Path Change Summary
packages/shader-lab/src/common/Keywords.ts Added new enum entry: GS_Editor in EKeyword.
packages/shader-lab/src/contentParser/KeywordMap.ts Added new entry: ["Editor", EKeyword.GS_Editor] in KeywordMap.
packages/shader-lab/src/contentParser/ShaderContentParser.ts Updated _parseShaderStatements to handle EKeyword.GS_Editor, modified error handling for render queue assignments.
packages/shader-lab/src/preprocessor/PpParser.ts Removed _skipEditorBlock, simplified _onToken to directly invoke _expandToken, updated error reporting logic.
packages/shader-lab/src/ShaderLab.ts Enhanced error handling and logging in _parseShaderPass and _parseShaderContent.
packages/shader-lab/src/ShaderLabUtils.ts Changed return type of createGSError method from implicit to Error, modified error handling logic.
packages/shader-lab/src/parser/ShaderTargetParser.ts Updated error handling in parse method to cast errors to GSError.
packages/shader-lab/src/codeGen/VisitorContext.ts Updated return types of referenceAttribute and referenceVarying methods from GSError to Error.
packages/shader-lab/src/codeGen/CodeGenVisitor.ts Introduced type assertions for error handling in visitPostfixExpression and visitFunctionCall methods.
tests/src/shader-lab/ShaderLab.test.ts Added multiple test cases for shader validation, updated error handling expectations in tests.

Possibly related PRs

Suggested labels

medium priority

Suggested reviewers

🐰 In the shader land, a new keyword's born,
With GS_Editor, the shaders adorn.
Parsing and mapping, errors now tamed,
In the code's bright garden, all is proclaimed!
So hop with delight, let the shaders play,
For bright new paths are paved today! 🌟

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 28b9a958e69de7bc52a2d254909d2f664c9ab0f7 and 2749c7612edc397338e13d37e72abcfcdce02501.
⛔ Files ignored due to path filters (1) * `tests/src/shader-lab/shaders/demo.shader` is excluded by `!**/*.shader`
📒 Files selected for processing (1) * `tests/src/shader-lab/ShaderLab.test.ts` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * tests/src/shader-lab/ShaderLab.test.ts

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.