Skip to content

Refactor logging and enhance documentation - #23

Merged
ptr727 merged 17 commits into
developfrom
agents
Jan 31, 2026
Merged

Refactor logging and enhance documentation#23
ptr727 merged 17 commits into
developfrom
agents

Conversation

@ptr727

@ptr727 ptr727 commented Jan 30, 2026

Copy link
Copy Markdown
Owner

Improve code structure and documentation across multiple files, enhance the logging framework with global configuration options, and update the testing framework references. Additionally, reorganize the README to clarify branching workflow requirements.

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…ve related documentation

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…e fixture

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…ne test delay handling

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…equirements

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 30, 2026 17:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This pull request refactors the logging infrastructure to provide global configuration options, upgrades the testing framework from xUnit v2 to v3, updates documentation references from FluentAssertions to AwesomeAssertions, and improves code organization across the project.

Changes:

  • Introduces a new global logging configuration system (LogOptions) that allows library consumers to configure logging via static properties, factory instances, or per-instance options
  • Upgrades test framework to xUnit v3 with enhanced features like TestContext.Current.CancellationToken and assembly fixtures
  • Removes redundant Husky.Net MSBuild targets (now using dotnet tools), SourceLink from application projects, and replaces #pragma directives with SuppressMessage attributes following coding guidelines
  • Adds comprehensive documentation files (CODESTYLE.md, AGENTS.md) and updates existing documentation to reflect AwesomeAssertions usage

Reviewed changes

Copilot reviewed 29 out of 31 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
Tests/Tests.csproj Upgrades from xUnit v2 to v3 package reference
Tests/SampleTest.cs Improves test naming, adds fixture inheritance, uses TestContext cancellation token
Tests/LoggingTests.cs Adds comprehensive test coverage for new logging infrastructure
Tests/GlobalUsings.cs Removes unused System.IO import
Tests/Fixture.cs Implements assembly fixture and sequential collection patterns for xUnit v3
Tests/.editorconfig Adds suppressions for XML docs and CA1515 in test code
Library/LogOptions.cs New global logging configuration class with thread-safe static properties
Library/Options.cs New options class for per-instance logger configuration
Library/Library.cs Refactored to use new logging options, adds StaticTemplateLibrary for static usage
Library/Extensions.cs Changes extension methods from public to internal visibility
Library/Library.csproj Removes Husky MSBuild target (now using dotnet tools)
Console/Program.cs Updates to use new logging configuration API
Console/LoggerFactory.cs Reorganizes code and adds CreateLoggerFactory method
Console/CommandLine.cs Reorders fields to follow StyleCop-like conventions
Console/Extensions.cs Removes redundant SuppressMessage attribute, relocates LogOverride class
Console/GlobalUsings.cs Adds Microsoft.Extensions.Logging and Serilog.Events global usings
Console/Console.csproj Removes SourceLink and Husky MSBuild target
Console/.editorconfig Improves comment clarity
CodeGen/HttpClientFactory.cs Enhances resilience handling to include exception detection
CodeGen/CommandLine.cs Reorders fields to follow StyleCop-like conventions
CodeGen/CodeGen.csproj Removes SourceLink and Husky MSBuild target
CodeGen/.editorconfig Improves comment clarity
Benchmarks/SampleBenchmark.cs Replaces #pragma with SuppressMessage attributes
Benchmarks/.editorconfig Adds suppression for XML docs in benchmark code
CODESTYLE.md New comprehensive code style and formatting reference
AGENTS.md New AI coding agent instructions document
.github/copilot-instructions.md Updates FluentAssertions references to AwesomeAssertions, adds new documentation sections
.editorconfig Removes trailing whitespace
.config/dotnet-tools.json Removes trailing newline
README.md Reorganizes table of contents to group related sections
ProjectTemplate.code-workspace Adds spelling exceptions for "Allman", "finalizers", and "LINQ"

Comment thread Library/Library.cs Outdated
Sections for standards and references were unintentionally condensed into single lines with diff markers, reducing readability. No content was changed, but Markdown formatting was negatively affected.
…on; add Console Test launch configuration

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 30, 2026 18:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Comment thread Console/LoggerFactory.cs Outdated
Comment thread Console/LoggerFactory.cs
… configuration

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…g file output template format

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 30, 2026 19:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Comment thread CodeGen/Program.cs
Comment thread CodeGen/Program.cs
…ole output

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…and improve test cases

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 30, 2026 22:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 25 out of 25 changed files in this pull request and generated 11 comments.

Comment thread Library/LogOptions.cs Outdated
Comment thread Library/Library.cs Outdated
Comment thread Tests/LoggingTests.cs Outdated
Comment thread CodeGen/Program.cs
Comment thread Library/LogOptions.cs Outdated
Comment thread Library/LogOptions.cs Outdated
Comment thread Library/Library.cs Outdated
Comment thread .editorconfig Outdated
Comment thread CodeGen/ApiNinjas.cs Outdated
Comment thread Console/Program.cs
…ordering guidelines

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…cumentation and tests for consistency

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
…readability

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 31, 2026 17:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 1 comment.

Comment thread CODESTYLE.md Outdated
…ility in logger creation

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 31, 2026 18:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 1 comment.

Comment thread CodeGen/CodeGenBuilder.cs
@ptr727
ptr727 merged commit 84a9667 into develop Jan 31, 2026
25 checks passed
@ptr727
ptr727 deleted the agents branch January 31, 2026 18:17
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.

2 participants