Apply required updates to BlazorEmpty project template (#11877)

[msynk]

closes #11877

Summary by CodeRabbit

Release Notes

• New Features

  • Added response compression support to improve performance.
  • Dynamic copyright year in footer component.

• Bug Fixes

  • Fixed memory leak in header component.
  • Resolved encoding issues across multiple template files.
  • Improved exception handling with dedicated error scoping.

• Chores

  • Updated template version to 10.0.
  • Updated Visual Studio solution format to version 18.
  • Removed unused development server configurations.
  • Updated button styling conventions in template pages.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This PR updates the BlazorEmpty template project by bumping the template version from 8.0 to 10.0, removing MCP configuration, fixing encoding issues across multiple files, adding IDisposable cleanup to Header.razor, updating the Footer with dynamic year rendering, modernizing button styling, enabling error scope creation, and adding response compression to the startup pipeline.

Changes

Cohort / File(s)	Summary
Configuration & Metadata src/Templates/BlazorEmpty/Bit.BlazorEmpty/.template.config/template.json, src/Templates/BlazorEmpty/Bit.BlazorEmpty/.vscode/mcp.json, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.sln	Template identity updated from 8.0 to 10.0; MCP server configurations removed entirely; solution format upgraded from version 16 to 18 with simplified platform configurations and updated SolutionItems mappings.
Program Initialization src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.Client/Program.cs, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Program.Main.cs, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Program.cs	BOM character fix in client Program.cs; exception handler now uses createScopeForErrors: true parameter; response compression middleware registered with new using directives.
Components src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/Header.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/Footer.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/MainLayout.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/Home.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/About.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/Error.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Routes.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/_Imports.razor, src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.Client/_Imports.razor	Header adds IDisposable with LocationChanged unsubscription; Footer displays dynamic current year; Home.razor button variant changed from BitButtonStyle.Standard to BitVariant.Outline; multiple files have BOM characters removed for encoding normalization.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~18 minutes

• IDisposable implementation in Header.razor—verify proper event unsubscription prevents memory leaks
• Exception handler modification in Program.Main.cs—confirm createScopeForErrors parameter intention and scope lifecycle semantics
• Solution file format upgrade (v16 → v18)—ensure compatibility with target Visual Studio versions and no build tooling regression

Poem

🐰 The template springs forth, renewed and refined,
Old BOMs are banished, encoding redesigned,
Version ten awakens with cleanup so keen,
A Header that listens, a Footer pristine—
Blazor blazes brighter, version eight's past!

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	The changeset introduces several out-of-scope modifications beyond the six stated objectives: BOM character fixes across multiple files, Footer.razor dynamic year implementation, and response compression additions in Program.cs are not mentioned in issue #11877.	Remove unrelated changes such as BOM fixes, Footer.razor year updates, and response compression code unless they are required dependencies. Maintain focus on the six specific objectives listed in issue #11877.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'Apply required updates to BlazorEmpty project template' clearly summarizes the main change and is fully related to updating the BlazorEmpty template as evidenced by all changeset modifications.
Linked Issues check	✅ Passed	All six coding objectives from issue #11877 are met: template identity updated [#11877], mcp.json removed [#11877], Header.razor Dispose added [#11877], Home.razor parameter changed [#11877], Program.Main.cs createScopeForErrors added [#11877], and .SolutionItems restored [#11877].

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Program.cs (1)

47-51: Consider using app.Environment for consistency.

After calling builder.Build(), it's more idiomatic to use app.Environment rather than builder.Environment when checking the environment in the middleware pipeline configuration.

-if (builder.Environment.IsDevelopment() is false)
+if (app.Environment.IsDevelopment() is false)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 1c3fd30 and ddc360e.

📒 Files selected for processing (16)

• src/Templates/BlazorEmpty/Bit.BlazorEmpty/.template.config/template.json (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/.vscode/mcp.json (0 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.Client/Program.cs (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.Client/_Imports.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.sln (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/App.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/Footer.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/Header.razor (2 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/MainLayout.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/About.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/Error.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/Home.razor (2 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Routes.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/_Imports.razor (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Program.Main.cs (2 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Program.cs (1 hunks)

💤 Files with no reviewable changes (1)

• src/Templates/BlazorEmpty/Bit.BlazorEmpty/.vscode/mcp.json

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build Bit.Templates

🔇 Additional comments (15)

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Program.cs (1)

1-3: Response compression setup looks good.

The service registration and middleware configuration follow the correct pattern. Enabling compression only in non-development environments is appropriate for easier debugging during development.

Also applies to: 10-11

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/About.razor (1)

1-1: LGTM!

BOM character removal is a good encoding cleanup.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/Error.razor (1)

1-1: LGTM!

BOM character removal is a good encoding cleanup.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/_Imports.razor (1)

1-1: LGTM!

BOM character removal is a good encoding cleanup.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.Client/_Imports.razor (1)

1-1: LGTM!

BOM character removal is a good encoding cleanup.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/MainLayout.razor (1)

1-1: LGTM! BOM cleanup improves encoding consistency.

The removal of the Byte Order Mark ensures consistent UTF-8 encoding across the template files.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Routes.razor (1)

1-1: LGTM! Encoding normalization.

The BOM removal aligns with the broader encoding cleanup effort across the template.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/App.razor (1)

1-1: LGTM! BOM cleanup.

Encoding normalization consistent with other template files.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/.template.config/template.json (1)

17-17: LGTM! Template version updated correctly.

The identity bump from 8.0 to 10.0 aligns with the PR objectives to update the template version.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/Footer.razor (1)

1-2: LGTM! Dynamic year rendering is a best practice.

The change from a static year to DateTimeOffset.Now.Year ensures the copyright year stays current automatically.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Pages/Home.razor (2)

1-1: LGTM! BOM cleanup.

Encoding normalization consistent with other template files.

---

29-29: No action required - button parameter usage is correct.

The Variant="BitVariant.Outline" parameter is the correct API for the BitButton component in Bit.BlazorUI version 10.2.1-pre-01. The Variant parameter is properly defined and BitVariant.Outline is a valid enum value that renders an outlined button style.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Program.Main.cs (1)

44-44: LGTM! Adding createScopeForErrors is a best practice.

The createScopeForErrors: true parameter ensures proper scoped service resolution in the error handling middleware.

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/Components/Layout/Header.razor (1)

1-1: LGTM! Proper IDisposable implementation.

The component correctly implements IDisposable to clean up the event subscription. This prevents potential memory leaks by unsubscribing from LocationChanged when the component is disposed.

Also applies to: 49-52

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.sln (1)

2-3: LGTM! Solution file updates align with template modernization.

The Visual Studio version bump to 18 and the addition of the .SolutionItems folder with project configuration files (Clean scripts, global.json, settings) are appropriate updates for the BlazorEmpty template.

Also applies to: 9-16