Added Ability to Designate Required Fields

[mitchelsellers]

• Fixes Add Support for "Required" indication on Labels #26

Summary by CodeRabbit

• New Features
  • Enhanced tag helpers with the ability to style labels as required using a red asterisk.
  • Introduced improved coverage reporting with Codacy integration.
  • Added new capabilities to form tag helpers for handling nullable enum types and required fields.
• Documentation
  • Updated README with new Codacy badge and added details on special features related to tag helpers.
• Tests
  • Added a new test for verifying the rendering of required classes in form inputs.
• Chores
  • Updated CI build process, including changes to the SonarCloud scanner installation and removal of caching steps.

[coderabbitai]

Walkthrough

The project underwent a significant update focusing on improving code analysis and quality tracking, enhancing the user interface for required fields, and refining testing capabilities. Changes include the removal of SonarCloud caching and update of its scanner installation, addition of Codacy for coverage tracking, UI updates for required field indications, and the introduction of logic to automatically mark form labels as required when applicable.

Changes

File(s)	Change Summary
.github/workflows/ci-build.yml	Updated SonarCloud scanner installation; added Codacy coverage push.
README.md	Replaced SonarCloud badges with Codacy badge; added tag helpers section.
src/.../SampleModel.cs, src/.../_Layout.cshtml, src/.../TestModel.cs	Adjusted model property type; added required field styling; added a new model property.
src/.../FormElementMixin.cs, src/.../FormInputTagHelperTests.cs, src/.../Renders_RequiredClassWhenNeeded.verified.html	Added logic for required class addition; added a test method; introduced a new HTML snippet.

Assessment against linked issues

Objective	Addressed	Explanation
Add Support for "Required" indication on Labels (#26)	✅

Poem

🐇✨
A leap, a hop, in the digital scape,
Where code evolves, and forms take shape.
Required fields now clearly marked,
In the glow of the screen, in the codebase dark.
A rabbit's work, through and through,
Crafting magic, making new.
🌟🐾

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 32548d2 and 9af52b5.

Files selected for processing (8)

• .github/workflows/ci-build.yml (2 hunks)
• README.md (2 hunks)
• src/AspNetCore.Utilities.Bootstrap5TagHelpers.Sample/Models/SampleModel.cs (1 hunks)
• src/AspNetCore.Utilities.Bootstrap5TagHelpers.Sample/Views/Shared/_Layout.cshtml (1 hunks)
• src/AspNetCore.Utilities.Bootstrap5TagHelpers.Tests/Form/FormInputTagHelperTests.cs (1 hunks)
• src/AspNetCore.Utilities.Bootstrap5TagHelpers.Tests/Form/TestModel.cs (1 hunks)
• src/AspNetCore.Utilities.Bootstrap5TagHelpers.Tests/VerifySnapshots/FormInputTagHelperTests.Renders_RequiredClassWhenNeeded.verified.html (1 hunks)
• src/AspNetCore.Utilities.Bootstrap5TagHelpers/Form/FormElementMixin.cs (2 hunks)

Additional comments: 9

src/AspNetCore.Utilities.Bootstrap5TagHelpers.Tests/Form/TestModel.cs (1)

• 8-9: The addition of the RequiredIntField property with a nullable type and the [Required] attribute is correctly implemented and follows best practices for nullable types and model validation in ASP.NET Core.

src/AspNetCore.Utilities.Bootstrap5TagHelpers.Tests/VerifySnapshots/FormInputTagHelperTests.Renders_RequiredClassWhenNeeded.verified.html (1)

• 3-3: The required class is correctly applied to the form label, demonstrating the feature's functionality to automatically mark form labels as required. The HTML structure and encoding practices are appropriate.

src/AspNetCore.Utilities.Bootstrap5TagHelpers.Sample/Models/SampleModel.cs (1)

• 41-41: Changing the SelectedListItem property to a nullable type (SampleEnum?) is correctly implemented and aligns with best practices for handling optional form fields in ASP.NET Core models.

.github/workflows/ci-build.yml (1)

• 47-55: The addition of the step to push coverage to Codacy is correctly implemented, with appropriate environment variables configured. This change aligns with the objectives to refine the CI build process and integrate with Codacy for code quality analysis.

src/AspNetCore.Utilities.Bootstrap5TagHelpers/Form/FormElementMixin.cs (1)

• 39-47: The logic to determine the presence of a RequiredAttribute and conditionally add the required class to form labels is correctly implemented. This change effectively enables the automatic marking of form labels as required, aligning with the feature's objectives.

src/AspNetCore.Utilities.Bootstrap5TagHelpers.Sample/Views/Shared/_Layout.cshtml (1)

• 10-15: The addition of the <style> block to style labels marked as required with a red asterisk is correctly implemented. This change aligns with the feature's objective to provide a clear visual indication for required fields.

src/AspNetCore.Utilities.Bootstrap5TagHelpers.Tests/Form/FormInputTagHelperTests.cs (1)

• 88-98: The new test method Renders_RequiredClassWhenNeeded is correctly implemented to verify the rendering of the required class on form labels when necessary. This test aligns with the feature's objectives and follows best practices for unit testing in ASP.NET Core.

README.md (2)

• 9-9: The replacement of the SonarCloud analysis badge with a Codacy badge in the README.md file correctly reflects the shift in tool preference for code quality analysis.
• 75-84: The addition of a section on special features related to tag helpers, specifically the automatic marking of form labels as required, is a valuable update to the README.md file. This documentation clearly communicates the new functionality to users.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 9af52b5 and 942b401.

Files selected for processing (1)

• .github/workflows/ci-build.yml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/ci-build.yml

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for 32548d21	✅ 100.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (32548d2)	Report Missing	Report Missing	Report Missing
Head commit (942b401)	387	381	98.45%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#27)	3	3	100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation}

Footnotes

1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct. ↩