galacean / effects-runtime

It can load and render cool animation effects
https://www.galacean.com/effects/
MIT License
367 stars 11 forks source link

fix: the reporting words for unexpected parse result #745

Closed zheeeng closed 2 weeks ago

zheeeng commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request involve modifications to the error messages in the richTextParser and its related functions. The updates focus on rephrasing error messages for clarity and consistency, particularly regarding expected start and end tags. The changes affect the Grammar, ContextStart, and ContextEnd functions, as well as the test cases in rich-text-parser.spec.ts, improving the overall error reporting mechanism without altering any public or exported entity declarations.

Changes

File Path Change Summary
plugin-packages/rich-text/src/rich-text-parser.ts Rephrased error messages in Grammar, ContextStart, and ContextEnd functions for clarity regarding expected tags.
plugin-packages/rich-text/test/src/rich-text-parser.spec.ts Updated error messages in test cases for clarity when handling unparsable rich text.

Poem

In the land of text where tags reside,
Errors once tangled, now clear as the tide.
With messages bright, like stars in the night,
Parsing is smoother, a joyful delight!
Hooray for the changes, let’s hop and cheer,
For clarity reigns, our path is now clear! πŸ‡βœ¨


πŸ“œ Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between bf124a8f87b1b818e1da49b8508287dc1aac71ce and 7e4c6a3504af3ec8f5b8abbab0056e66d5f50cfc.
πŸ“’ Files selected for processing (2) * `plugin-packages/rich-text/src/rich-text-parser.ts` (4 hunks) * `plugin-packages/rich-text/test/src/rich-text-parser.spec.ts` (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * plugin-packages/rich-text/src/rich-text-parser.ts
πŸ”‡ Additional comments (2)
plugin-packages/rich-text/test/src/rich-text-parser.spec.ts (2) `264-264`: **LGTM! Improved error message clarity.** The updated error message is clearer and more precise in describing the parsing error. Let's verify that this matches the actual error message from the parser: --- `276-276`: **LGTM! Improved error message clarity.** The updated error message is more consistent with the previous error message format and clearer in describing the missing end tag. Let's verify that this matches the actual error message from the parser:

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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) 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.