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: extra menu title follow locale change #5006

Merged
merged 1 commit into from
Dec 4, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 3, 2024

Description

修复双列菜单布局下,子级扩展菜单的语言没有跟随当前语言设置动态更新的问题

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features
    • Enhanced menu translation functionality, allowing for deeper or shallower processing of menu items based on user interface requirements.
  • Bug Fixes
    • Adjusted menu item display to ensure proper translation at the first level in specific contexts.

Copy link

changeset-bot bot commented Dec 3, 2024

⚠️ No Changeset found

Latest commit: cd16c58

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The pull request modifies the wrapperMenus function in the layout.vue file by adding a new parameter, deep, which defaults to true. This allows the function to conditionally process menu items either recursively or at a single level based on the value of deep. The invocation of wrapperMenus in the mixed-menu template has been updated to pass false for deep, changing how menu translations are applied. The overall control flow and error handling remain unchanged.

Changes

File Path Change Summary
packages/effects/layouts/src/basic/layout.vue Updated wrapperMenus function to accept an additional deep parameter; modified its invocation in mixed-menu template to pass false.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

🐰 In the land of menus, so bright and neat,
A new way to wrap, oh what a treat!
With deep or not deep, we choose how to play,
Translating our items in a clever way.
Hopping through code, with joy we will sing,
For menus that dance, oh what joy they bring! 🌟

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/effects/layouts/src/basic/layout.vue

Oops! Something went wrong! :(

ESLint: 9.16.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)


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>, 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 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

🧹 Outside diff range and nitpick comments (1)
packages/effects/layouts/src/basic/layout.vue (1)

113-125: LGTM! Consider enhancing the documentation.

The implementation correctly addresses the locale change issue by allowing selective depth translation. The code is well-structured and type-safe.

Consider adding a code example in the documentation to illustrate the difference between deep and shallow translation:

 /**
  * 包装菜单,翻译菜单名称
  * @param menus 原始菜单数据
  * @param deep 是否深度包装。对于双列布局,只需要包装第一层,因为更深层的数据会在扩展菜单中重新包装
+ * @example
+ * // Deep translation (default)
+ * wrapperMenus(menus) // translates all nested levels
+ * // Shallow translation
+ * wrapperMenus(menus, false) // translates only first level
  */
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 24b9aa4 and cd16c58.

📒 Files selected for processing (1)
  • packages/effects/layouts/src/basic/layout.vue (2 hunks)
🔇 Additional comments (1)
packages/effects/layouts/src/basic/layout.vue (1)

269-269: LGTM! Verify menu translation behavior.

The change correctly implements shallow translation for mixed-menu while maintaining deep translation for extra menus.

Let's verify the menu translation behavior across different components:

✅ Verification successful

Menu translation configuration is correctly implemented

The verification confirms that:

  • The wrapperMenus function is consistently used across different menu components
  • Mixed menu (headerMenus) correctly uses shallow translation with false parameter
  • Extra menu still uses deep translation (default true parameter)
  • Other menu instances maintain their expected translation behavior
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify consistent usage of wrapperMenus across menu components

# Check if wrapperMenus is used correctly in all menu-related components
echo "Checking wrapperMenus usage in menu components..."
rg -A 2 "wrapperMenus\(" --type vue

# Verify that LayoutExtraMenu still uses deep translation
echo "Verifying LayoutExtraMenu translation depth..."
rg -A 5 "LayoutExtraMenu" --type vue

Length of output: 342


Script:

#!/bin/bash
# Let's try without specifying file type since 'vue' is not recognized
# Search for wrapperMenus usage
echo "Checking wrapperMenus usage..."
rg -A 2 "wrapperMenus\("

# Search for LayoutExtraMenu
echo "Verifying LayoutExtraMenu..."
rg -A 5 "LayoutExtraMenu"

Length of output: 2837

@anncwb anncwb merged commit 9b73792 into vbenjs:main Dec 4, 2024
14 checks passed
@anncwb anncwb added the bug Something isn't working label Dec 4, 2024
@mynetfan mynetfan deleted the fix/mixed-menu-locale branch December 5, 2024 04:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants