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

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>
CopilotAI review requested due to automatic review settings January 30, 2026 17:36

CopilotAI 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
FileDescription
Tests/Tests.csprojUpgrades from xUnit v2 to v3 package reference
Tests/SampleTest.csImproves test naming, adds fixture inheritance, uses TestContext cancellation token
Tests/LoggingTests.csAdds comprehensive test coverage for new logging infrastructure
Tests/GlobalUsings.csRemoves unused System.IO import
Tests/Fixture.csImplements assembly fixture and sequential collection patterns for xUnit v3
Tests/.editorconfigAdds suppressions for XML docs and CA1515 in test code
Library/LogOptions.csNew global logging configuration class with thread-safe static properties
Library/Options.csNew options class for per-instance logger configuration
Library/Library.csRefactored to use new logging options, adds StaticTemplateLibrary for static usage
Library/Extensions.csChanges extension methods from public to internal visibility
Library/Library.csprojRemoves Husky MSBuild target (now using dotnet tools)
Console/Program.csUpdates to use new logging configuration API
Console/LoggerFactory.csReorganizes code and adds CreateLoggerFactory method
Console/CommandLine.csReorders fields to follow StyleCop-like conventions
Console/Extensions.csRemoves redundant SuppressMessage attribute, relocates LogOverride class
Console/GlobalUsings.csAdds Microsoft.Extensions.Logging and Serilog.Events global usings
Console/Console.csprojRemoves SourceLink and Husky MSBuild target
Console/.editorconfigImproves comment clarity
CodeGen/HttpClientFactory.csEnhances resilience handling to include exception detection
CodeGen/CommandLine.csReorders fields to follow StyleCop-like conventions
CodeGen/CodeGen.csprojRemoves SourceLink and Husky MSBuild target
CodeGen/.editorconfigImproves comment clarity
Benchmarks/SampleBenchmark.csReplaces #pragma with SuppressMessage attributes
Benchmarks/.editorconfigAdds suppression for XML docs in benchmark code
CODESTYLE.mdNew comprehensive code style and formatting reference
AGENTS.mdNew AI coding agent instructions document
.github/copilot-instructions.mdUpdates FluentAssertions references to AwesomeAssertions, adds new documentation sections
.editorconfigRemoves trailing whitespace
.config/dotnet-tools.jsonRemoves trailing newline
README.mdReorganizes table of contents to group related sections
ProjectTemplate.code-workspaceAdds spelling exceptions for "Allman", "finalizers", and "LINQ"

Comment threadLibrary/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>
CopilotAI review requested due to automatic review settings January 30, 2026 18:58

CopilotAI 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 threadConsole/LoggerFactory.cs Outdated
Comment threadConsole/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>
CopilotAI review requested due to automatic review settings January 30, 2026 19:34

CopilotAI 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 threadCodeGen/Program.cs
Comment threadCodeGen/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>
CopilotAI review requested due to automatic review settings January 30, 2026 22:29

CopilotAI 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 threadLibrary/LogOptions.cs Outdated
Comment threadLibrary/Library.cs Outdated
Comment threadTests/LoggingTests.cs Outdated
Comment threadCodeGen/Program.cs
Comment threadLibrary/LogOptions.cs Outdated
Comment threadLibrary/LogOptions.cs Outdated
Comment threadLibrary/Library.cs Outdated
Comment thread.editorconfig Outdated
Comment threadCodeGen/ApiNinjas.cs Outdated
Comment threadConsole/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>
CopilotAI review requested due to automatic review settings January 31, 2026 17:48

CopilotAI 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 threadCODESTYLE.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>
CopilotAI review requested due to automatic review settings January 31, 2026 18:04

CopilotAI 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 threadCodeGen/CodeGenBuilder.cs
@ptr727
ptr727 merged commit 84a9667 into developJan 31, 2026
25 checks passed
@ptr727
ptr727 deleted the agents branch January 31, 2026 18:17
Sign up for freeto 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

@ptr727