ShaderLab ignore EditorScript directive

[Sway007]

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:

related PR: @galacean/editor#2849

Summary by CodeRabbit

• New Features

  • Introduced a new enumeration for editor keywords, improving clarity and reducing errors related to string literals.

• Bug Fixes

  • Enhanced type safety in the _skipEditorBlock method by replacing string literals with enumerated types, improving maintainability.

[coderabbitai]

Walkthrough

The recent updates enhance the PpParser class by integrating an enumeration for editor keywords, replacing string literals with type-safe constants. This change improves code maintainability and clarity, particularly in the _skipEditorBlock method, which now handles script tokens more effectively. The introduction of EEditorKeywords streamlines keyword usage across the codebase, promoting a more robust implementation.

Changes

Files	Change Summary
packages/shader-lab/src/preprocessor/PpParser.ts packages/shader-lab/src/preprocessor/constants.ts	Updated _skipEditorBlock to use EEditorKeywords for type safety; added EEditorKeywords enum with Property, Macro, and Script.

Poem

🐰 In the land of code, where constants gleam,
A parser awoke from a programmer's dream.
With keywords that sing, and types that align,
Our code now dances, so clear and divine!
Editor blocks skip with a hop and a cheer,
For safer, neat code is now ever near! 🌟

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 64ad5f4 and 865bb9a.

Files selected for processing (2)

• packages/shader-lab/src/preprocessor/PpParser.ts (2 hunks)
• packages/shader-lab/src/preprocessor/constants.ts (1 hunks)

Additional comments not posted (4)

packages/shader-lab/src/preprocessor/constants.ts (1)

74-78: LGTM! The new enumeration improves type safety and maintainability.

The introduction of EEditorKeywords provides a clear set of predefined keywords, reducing the likelihood of errors related to string literals.

packages/shader-lab/src/preprocessor/PpParser.ts (3)

9-9: LGTM! The new import improves type safety and maintainability.

The import of EEditorKeywords from constants ensures that the new enumeration can be used throughout the file.

---

625-633: LGTM! The updated conditions improve type safety.

The conditions in _skipEditorBlock now use EEditorKeywords.Property and EEditorKeywords.Macro, enhancing type safety by replacing hardcoded strings with enumerations.

---

634-640: LGTM! The new branch for EEditorKeywords.Script expands functionality.

The new conditional branch for EEditorKeywords.Script allows the _skipEditorBlock method to handle script tokens by scanning for quoted strings.