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

feat(registerBootstrapBlazorModule ): add registerBootstrapBlazorModule in utility #5487

Merged
merged 6 commits into from
Mar 2, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 2, 2025

Link issues

fixes #5486

Summary By Copilot

This pull request includes several changes to the src/BootstrapBlazor components, focusing on code simplification and modularization. The main improvements include the introduction of a registerBootstrapBlazorModule function and the refactoring of existing code to use this new function.

Code Simplification and Modularization:

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Introduces a registerBootstrapBlazorModule function to streamline module registration and enhance code modularity. Refactors existing components to utilize this new function, promoting a more organized and maintainable codebase.

Enhancements:

  • Introduces a registerBootstrapBlazorModule function in utility.js to centralize module registration logic.
  • Enhances the deepMerge function in utility.js to include an optional skipNull parameter, allowing for more flexible object merging.
  • Refactors the AutoComplete component to use the new registerBootstrapBlazorModule function.
  • Refactors the hackTooltip function to use the new registerBootstrapBlazorModule function.

Copy link

sourcery-ai bot commented Mar 2, 2025

Reviewer's Guide by Sourcery

This pull request introduces a registerBootstrapBlazorModule function in utility.js to simplify and centralize the registration of BootstrapBlazor modules. The AutoComplete and Tooltip components were refactored to use this new function. Additionally, the deepMerge function was enhanced with a skipNull parameter to allow for more flexible object merging.

Class diagram for BootstrapBlazor module registration

classDiagram
  class BootstrapBlazor {
    <<static>> Tooltip
    <<static>> AutoComplete
  }
  class Tooltip {
    <<static>> hooked
    <<static>> hackDispose()
  }
  class AutoComplete {
    <<static>> hooked
    <<static>> registerCloseDropdownHandler()
  }

  BootstrapBlazor -- Tooltip
  BootstrapBlazor -- AutoComplete
Loading

File-Level Changes

Change Details Files
Introduced a utility function to register BootstrapBlazor modules.
  • Added registerBootstrapBlazorModule function to encapsulate the logic for registering modules within the BootstrapBlazor namespace.
  • The function ensures the BootstrapBlazor namespace exists and merges the provided module into it, handling potential conflicts.
  • The function also uses deepMerge to merge the module into the BootstrapBlazor namespace.
src/BootstrapBlazor/wwwroot/modules/utility.js
Refactored AutoComplete component to use the new module registration function.
  • Replaced the previous manual module initialization with registerBootstrapBlazorModule.
  • The registerCloseDropdownHandler function is now registered as part of the AutoComplete module.
  • Removed the conditional check for window.BootstrapBlazor.AutoComplete.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js
Refactored Tooltip component to use the new module registration function.
  • Replaced the previous manual module initialization with registerBootstrapBlazorModule.
  • The hackDispose function is now registered as part of the Tooltip module.
  • Removed the conditional check for window.BootstrapBlazor.Tooltip.
src/BootstrapBlazor/wwwroot/modules/utility.js
Enhanced the deepMerge function to include an optional skipNull parameter.
  • Added a skipNull parameter to the deepMerge function.
  • When skipNull is true, null values in the source object are not copied to the target object.
src/BootstrapBlazor/wwwroot/modules/utility.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5486 Add registerBootstrapBlazorModule in utility.js.
#5486 Refactor existing code to use the new registerBootstrapBlazorModule function.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Mar 2, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 2, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) March 2, 2025 02:38
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a check in registerBootstrapBlazorModule to prevent overwriting existing modules with the same name.
  • The skipNull parameter in deepMerge could potentially break existing functionality; ensure thorough testing.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Mar 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (291eb63) to head (02c3340).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5487   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29541     29541           
  Branches      4163      4163           
=========================================
  Hits         29541     29541           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang disabled auto-merge March 2, 2025 02:42
@ArgoZhang ArgoZhang merged commit 5b6fb3b into main Mar 2, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the chore-js branch March 2, 2025 02:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(registerBootstrapBlazorModule ): add registerBootstrapBlazorModule in utility
1 participant