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

doc(StaticAsset): use WebsiteOption AssetRootPath parameter #4775

Merged
merged 26 commits into from
Dec 2, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 2, 2024

use WebsiteOption AssetRootPath parameter

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4774

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

Refactor components to use the AssetRootPath parameter from WebsiteOptions for generating asset URLs, enhancing maintainability and flexibility in asset management.

Enhancements:

  • Utilize the AssetRootPath parameter from WebsiteOptions to dynamically generate asset URLs across various components, improving maintainability and flexibility.

Documentation:

  • Update documentation to reflect changes in asset URL handling using the AssetRootPath parameter.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Dec 2, 2024
Copy link

sourcery-ai bot commented Dec 2, 2024

Reviewer's Guide by Sourcery

This PR updates the static asset path handling across the application by introducing a centralized AssetRootPath parameter in WebsiteOptions. The changes replace hardcoded asset paths with a configurable path through WebsiteOption.GetAssetUrl() method.

Sequence diagram for asset URL retrieval

sequenceDiagram
    actor User
    participant Component
    participant WebsiteOptions
    User->>Component: Request asset
    Component->>WebsiteOptions: GetAssetUrl("images/example.png")
    WebsiteOptions-->>Component: "./_content/BootstrapBlazor.Shared/images/example.png"
    Component-->>User: Return asset URL
Loading

File-Level Changes

Change Details Files
Introduced centralized asset path configuration through WebsiteOptions
  • Added AssetRootPath property to WebsiteOptions class with default value './_content/BootstrapBlazor.Shared/'
  • Added GetAssetUrl() helper method to WebsiteOptions for constructing asset URLs
  • Added JSModuleRootPath property for JavaScript module path configuration
src/BootstrapBlazor.Shared/Data/WebsiteOptions.cs
Refactored static asset references to use WebsiteOption.GetAssetUrl()
  • Updated image URLs to use GetAssetUrl()
  • Updated JavaScript module paths to use JSModuleRootPath
  • Updated CSS file references to use GetAssetUrl()
  • Removed hardcoded asset paths
src/BootstrapBlazor.Shared/Components/Samples/MouseFollowers.razor
src/BootstrapBlazor.Shared/Components/Samples/Carousels.razor
src/BootstrapBlazor.Shared/Components/Samples/Live2DDisplays.razor
src/BootstrapBlazor.Shared/Components/Components/Pre.razor
src/BootstrapBlazor.Shared/Components/Components/Header.razor
src/BootstrapBlazor.Shared/Components/Layout/PageLayout.razor
Updated JavaScript module loading configuration
  • Modified JSModuleAutoLoader attributes to use relative paths
  • Updated module path construction to use WebsiteOption.JSModuleRootPath
  • Simplified module loading code
src/BootstrapBlazor.Shared/Components/Components/Pre.razor.js
src/BootstrapBlazor.Shared/Components/Components/WebSiteModuleComponentBase.cs
Cleaned up and standardized asset handling in services
  • Removed redundant path construction code
  • Simplified file path handling in services
  • Updated file upload and download functionality to use WebsiteOptions
src/BootstrapBlazor.Server/Services/ClearUploadFilesService.cs
src/BootstrapBlazor.Server/Controllers/WaterfallController.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4774 Add documentation for using WebsiteOption AssetRootPath parameter

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 this to the v9.0.0 milestone Dec 2, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 2, 2024
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 and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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 Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f8827f5) to head (c8fe9b7).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4775   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27424     27424           
  Branches      3925      3925           
=========================================
  Hits         27424     27424           

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

@ArgoZhang ArgoZhang merged commit 6056a9b into main Dec 2, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-path branch December 2, 2024 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(StaticAsset): use WebsiteOption AssetRootPath parameter
1 participant