Skip to content

fix: wrong composable usage and spelling#640

Merged
chilingling merged 4 commits intoopentiny:refactor/developfrom
hexqi:fix/errors
Jul 12, 2024
Merged

fix: wrong composable usage and spelling#640
chilingling merged 4 commits intoopentiny:refactor/developfrom
hexqi:fix/errors

Conversation

@hexqi
Copy link
Collaborator

@hexqi hexqi commented Jul 9, 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

  • Refactor

    • Improved encapsulation and separation of concerns by restructuring function interactions with external dependencies in the block settings.
  • Bug Fixes

    • Corrected variable and function names in the DataSourceRecordForm to ensure proper initialization and validation.
    • Addressed issues in the script methods by localizing useModal() calls within specific functions.
  • Chores

    • Streamlined the setup function in TablePager for better parameter handling.
  • New Features

    • Enhanced block and page management functionalities by refining how states and plugin information are handled in the toolbar script.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 9, 2024

Walkthrough

The recent changes focus on refactoring the codebase to enhance the modularity and maintainability by utilizing hooks consistently across different files. This involves moving variable declarations inside functions, renaming constants for clarity, and restructuring function calls to improve encapsulation and separation of concerns.

Changes

File Change Summary
packages/design-core/src/App.vue Moved message variable declaration inside the setup() function using useModal().
packages/plugins/block/src/js/blockSetting.jsx Refactored functions to use hooks like useBlock(), useTranslate(), useModal(), useCanvas().
packages/plugins/datasource/src/DataSourceRecordForm.vue Renamed constants and fixed function name typos affecting form data initialization and validation.
packages/plugins/script/src/js/method.js Introduced localized useModal() calls within saveMethods and close functions, removing global calls.
packages/settings/props/src/components/groups/TablePager.vue Removed emit parameter from setup function.
packages/toolbars/save/src/js/index.js Restructured usage of hooks and variables related to plugin information, block, and page states.

Poem

In code we trust, refactor we must,
Hooks to the rescue, encapsulate the flux.
Constants aligned, typos now fine,
With useModal we shine, our message divine.
A rabbit's delight, code changes in sight,
🐰✨ Code refactored right, brings joy and light!


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.
    • @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 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 38745df and 73db17b.

Files selected for processing (6)
  • packages/design-core/src/App.vue (1 hunks)
  • packages/plugins/block/src/js/blockSetting.jsx (14 hunks)
  • packages/plugins/datasource/src/DataSourceRecordForm.vue (5 hunks)
  • packages/plugins/script/src/js/method.js (3 hunks)
  • packages/settings/props/src/components/groups/TablePager.vue (1 hunks)
  • packages/toolbars/save/src/js/index.js (6 hunks)
Files skipped from review due to trivial changes (1)
  • packages/settings/props/src/components/groups/TablePager.vue
Additional comments not posted (24)
packages/design-core/src/App.vue (1)

24-24: Ensure proper usage of useModal() hook.

The message variable is now correctly scoped within the setup() function using the useModal() hook. This change improves encapsulation.

packages/toolbars/save/src/js/index.js (5)

30-31: Ensure correct usage of useLayout and useBlock hooks.

The PLUGIN_NAME and getPluginApi are now correctly retrieved using the useLayout hook, and getCurrentBlock is retrieved using the useBlock hook. This change improves consistency.


46-46: Ensure correct usage of useCanvas hook.

The currentPage is now correctly retrieved using the useCanvas hook. This change maintains the functionality and improves consistency.


57-58: Ensure correct usage of usePage and useCanvas hooks.

The pageSettingState and isTemporaryPage are now correctly retrieved using the usePage hook, and isBlock, canvasApi, and pageState are retrieved using the useCanvas hook. This restructuring improves code readability and maintainability.


86-86: Ensure correct usage of useCanvas hook.

The isSaved and canvasApi are now correctly retrieved using the useCanvas hook. This change maintains the functionality and improves consistency.


120-120: Ensure correct usage of useCanvas and useLayout hooks.

The commented-out code correctly shows the usage of useCanvas and useLayout hooks for retrieving plugin API and block/page information. Ensure this code is correctly utilized if uncommented in the future.

packages/plugins/script/src/js/method.js (2)

83-83: Ensure correct usage of useModal for message.

The message function is now correctly localized within the saveMethods function using the useModal hook. This change improves encapsulation.


127-127: Ensure correct usage of useModal for confirm.

The confirm function is now correctly localized within the close function using the useModal hook. This change improves encapsulation.

packages/plugins/datasource/src/DataSourceRecordForm.vue (4)

56-66: Correct spelling errors in constant names.

The spelling errors in the constant names have been corrected. Ensure that these corrected names are used consistently throughout the file.


91-95: Correct spelling error in function name.

The spelling error in the function name init has been corrected. Ensure that this corrected name is used consistently throughout the file.


146-148: Correct spelling errors in validation messages.

The spelling errors in the validation messages have been corrected. Ensure that these corrected messages are used consistently throughout the file.


163-185: Correct spelling errors in format keys and validation messages.

The spelling errors in the format keys and validation messages have been corrected. Ensure that these corrected keys and messages are used consistently throughout the file.

packages/plugins/block/src/js/blockSetting.jsx (12)

344-344: LGTM! Correct usage of useBlock().addBlockProperty.

The change correctly uses the useBlock hook to add a block property.


358-358: LGTM! Correct usage of useBlock().addBlockEvent.

The change correctly uses the useBlock hook to add a block event.


381-381: LGTM! Correct usage of useBlock().getCurrentBlock.

The change correctly uses the useBlock hook to get the current block.


415-416: LGTM! Correct usage of useBlock().getBlockList and useModal().message.

The change correctly uses the useBlock and useModal hooks to manage block deletion and display messages.


541-541: LGTM! Correct usage of useModal().message.

The change correctly uses the useModal hook to display messages.


560-560: LGTM! Correct usage of useModal().confirm.

The change correctly uses the useModal hook to display confirmation dialogs.


582-582: LGTM! Correct usage of useModal().message.

The change correctly uses the useModal hook to display messages.


591-591: LGTM! Correct usage of useBlock().setCategoryList.

The change correctly uses the useBlock hook to set the category list.


Line range hint 598-616:
LGTM! Correct usage of useModal().message, useTranslate().batchCreateI18n, and useCanvas().setSaved.

The change correctly uses the useModal, useTranslate, and useCanvas hooks for message display, translation creation, and canvas state management.


666-669: LGTM! Correct usage of useCanvas().setSaved and useModal().message.

The change correctly uses the useCanvas and useModal hooks for canvas state management and message display.


690-690: LGTM! Correct usage of useMaterial().getMaterial.

The change correctly uses the useMaterial hook to get material information.


743-743: LGTM! Correct usage of useBlock().setBlockList.

The change correctly uses the useBlock hook to set the block list.

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 73db17b and ad0406f.

Files selected for processing (1)
  • packages/plugins/block/src/js/blockSetting.jsx (14 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/plugins/block/src/js/blockSetting.jsx

@chilingling chilingling merged commit 69d1012 into opentiny:refactor/develop Jul 12, 2024
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
* fix: wrong composable usage  and spelling
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.

3 participants