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

fix(cli): 改造cli创建模版,让新建的地代码平台可以正常启动 #510

Merged
merged 1 commit into from
May 25, 2024

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented May 25, 2024

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Introduced a new design canvas with loading animations and enhanced element styling.
    • Added functionality for rendering with @opentiny/tiny-engine-canvas.
  • Dependencies

    • Updated dependencies to include @opentiny/tiny-engine-canvas and @opentiny/vite-plugin-generate-comments.
  • Configuration

    • Improved configuration setup by integrating defaultConfig from @opentiny/tiny-engine/vite.config.js.

Copy link
Contributor

coderabbitai bot commented May 25, 2024

Walkthrough

The recent updates introduce a new HTML template for a design canvas, integrate a new rendering functionality using @opentiny/tiny-engine-canvas, and revise the configuration in engine.config.js to use defaultConfig from @opentiny/tiny-engine. Additionally, new dependencies and devDependencies have been added to the package.json file to support these changes.

Changes

Files Change Summary
packages/engine-cli/template/canvas.html Introduced an HTML template for a design canvas with various elements and animations.
packages/engine-cli/template/engine.config.js Replaced vue import with defaultConfig and updated viteConfig setup using defineConfig.
packages/engine-cli/template/package.json Added new dependencies: "@opentiny/tiny-engine-canvas" and "@opentiny/vite-plugin-generate-comments".
packages/engine-cli/template/src/canvas.js Introduced functionality for creating a render using @opentiny/tiny-engine-canvas.

🐰✨
In the land of code and light,
New canvas blooms, a splendid sight.
Configs changed, dependencies grow,
With Tiny Engine, onward we go.
A rabbit's cheer for updates bright,
To the future, coding's delight!
🌟🖥️

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

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>.
    • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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
Contributor

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 82af56c and f6fe353.
Files selected for processing (4)
  • packages/engine-cli/template/canvas.html (1 hunks)
  • packages/engine-cli/template/engine.config.js (1 hunks)
  • packages/engine-cli/template/package.json (1 hunks)
  • packages/engine-cli/template/src/canvas.js (1 hunks)
Files skipped from review due to trivial changes (2)
  • packages/engine-cli/template/canvas.html
  • packages/engine-cli/template/src/canvas.js
Additional comments not posted (4)
packages/engine-cli/template/package.json (2)

19-20: Addition of @opentiny/vite-plugin-generate-comments supports the PR's documentation enhancements.

Verification successful

The integration of @opentiny/vite-plugin-generate-comments has been confirmed in the packages/design-core/vite.config.js file. This indicates that the plugin is being utilized in the project.

  • packages/design-core/vite.config.js: import generateComment from '@opentiny/vite-plugin-generate-comments'
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the integration of `@opentiny/vite-plugin-generate-comments` in the project.

# Test: Search for usage of `@opentiny/vite-plugin-generate-comments` in the project. Expect: At least one usage.
rg --type json '@opentiny/vite-plugin-generate-comments'

Length of output: 366



Script:

#!/bin/bash
# Description: Verify the integration of `@opentiny/vite-plugin-generate-comments` in the project.

# Test: Search for usage of `@opentiny/vite-plugin-generate-comments` in JavaScript/TypeScript files. Expect: At least one usage.
rg '@opentiny/vite-plugin-generate-comments' --type js --type ts

Length of output: 170


13-14: Addition of @opentiny/tiny-engine-canvas aligns with the PR's enhancements.

Verification successful

The integration of @opentiny/tiny-engine-canvas is confirmed through multiple instances of its usage across various files in the codebase. This includes imports in JavaScript and Vue files, as well as references in configuration files.

  • packages/engine-cli/template/src/canvas.js: import { createRender } from '@opentiny/tiny-engine-canvas'
  • packages/plugins/materials/src/component/Main.vue: import { CanvasDragItem } from '@opentiny/tiny-engine-canvas'
  • packages/design-core/src/canvas.js: import { createRender } from '@opentiny/tiny-engine-canvas'
  • packages/design-core/src/DesignCanvas.vue: import { CanvasContainer, CanvasFooter } from '@opentiny/tiny-engine-canvas'
  • packages/design-core/vite.config.js: @opentiny/tiny-engine-canvas: path.resolve(__dirname, '../canvas/src/index.js')

These instances indicate that the dependency is actively used in the project.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the integration of `@opentiny/tiny-engine-canvas` in the project.

# Test: Search for usage of `@opentiny/tiny-engine-canvas` in the project. Expect: At least one usage.
rg --type json '@opentiny/tiny-engine-canvas'

Length of output: 1880



Script:

#!/bin/bash
# Description: Verify the actual usage of `@opentiny/tiny-engine-canvas` in the codebase.

# Test: Search for usage of `@opentiny/tiny-engine-canvas` in the codebase. Expect: At least one usage.
rg '@opentiny/tiny-engine-canvas'

Length of output: 2418

packages/engine-cli/template/engine.config.js (2)

17-17: Dynamic configuration in viteConfig enhances flexibility.

Verification successful

The dynamic configuration in viteConfig is used in several places within the codebase, confirming its integration.

  • packages/engine-cli/src/common.js
  • packages/engine-cli/src/commands/serve.js
  • packages/engine-cli/src/commands/build.js
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the dynamic configuration in `viteConfig`.

# Test: Search for usage of `viteConfig` in the project. Expect: At least one usage.
rg --type javascript 'viteConfig'

Length of output: 68



Script:

#!/bin/bash
# Description: Verify the dynamic configuration in `viteConfig`.

# Test: Search for usage of `viteConfig` in the project. Expect: At least one usage.
rg 'viteConfig'

Length of output: 593


13-14: Change in imports to use @opentiny/tiny-engine/vite.config.js standardizes configurations.

@hexqi hexqi merged commit cdba368 into refactor/develop May 25, 2024
1 check passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 30, 2024
14 tasks
@coderabbitai coderabbitai bot mentioned this pull request Feb 5, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants