Skip to content

Align csproj formatting with SarifMark reference and enable TreatWarningsAsErrors#90

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/cleanup-csproj-formatting
Feb 5, 2026
Merged

Align csproj formatting with SarifMark reference and enable TreatWarningsAsErrors#90
Malcolmnixon merged 3 commits intomainfrom
copilot/cleanup-csproj-formatting

Conversation

Copy link
Contributor

Copilot AI commented Feb 5, 2026

Pull Request

Description

Standardizes csproj configuration across both main and test projects to match the SarifMark reference implementation. Enables strict warning enforcement and documentation generation with consistent formatting conventions.

Key changes:

  • Code Quality: Enabled TreatWarningsAsErrors and GenerateDocumentationFile in both projects
  • NuGet Metadata: Added PackageTags, Copyright, Title, and Product properties
  • Symbol Configuration: Added EmbedUntrackedSources for better debugging support
  • Formatting: Normalized LangVersion to 12 (from 12.0) and enforced consistent lowercase true for all boolean values
  • Test Fix: Converted invalid XML doc on assembly attribute to regular comment in AssemblyInfo.cs

Type of Change

  • 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)
  • Documentation update
  • Code quality improvement

Related Issues

References issue requesting SarifMark-style configuration and TreatWarningsAsErrors enforcement.

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All tests pass: dotnet test --configuration Release
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Build now enforces zero warnings across all target frameworks (net8.0, net9.0, net10.0). All 109 tests pass with stricter quality settings enabled. All boolean values in csproj files now consistently use lowercase true for improved formatting consistency.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Csproj Cleanup</issue_title>
<issue_description>### Problem Statement

The csproj file formatting and quality settings should be more consistent.

Proposed Solution

Follow the csproj formatting and code quality configuration settings from https://github.com/demaconsulting/SarifMark/blob/main/src/DemaConsulting.SarifMark/DemaConsulting.SarifMark.csproj including enabling the TreatWarningsAsErrors = true

Alternatives Considered

No response

Usage Examples

Benefits

Simpler configuration organization

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…rningsAsErrors

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon
Copy link
Contributor

@copilot Please us consistent lowercase 'true' for csproj files

Copilot AI changed the title [WIP] Fix csproj file formatting and quality settings Align csproj formatting with SarifMark reference and enable TreatWarningsAsErrors Feb 5, 2026
Copilot AI requested a review from Malcolmnixon February 5, 2026 12:41
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 5, 2026

@copilot Please us consistent lowercase 'true' for csproj files

Changed GenerateDocumentationFile to use lowercase 'true' in both csproj files for consistency with other boolean values. Fixed in commit 33e5c8e.

@Malcolmnixon Malcolmnixon marked this pull request as ready for review February 5, 2026 12:50
@Malcolmnixon Malcolmnixon merged commit a3e9491 into main Feb 5, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/cleanup-csproj-formatting branch February 5, 2026 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Csproj Cleanup

2 participants