Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown writer #1102

Merged
merged 6 commits into from
Mar 21, 2024
Merged

Markdown writer #1102

merged 6 commits into from
Mar 21, 2024

Conversation

erri120
Copy link
Member

@erri120 erri120 commented Mar 20, 2024

Part of #327.

Allows value formatters to write either plain text or markdown depending on the state.

This PR doesn't include a markdown renderer.

@erri120 erri120 added the Epic: Diagnostics This is related to the Diagnostic System label Mar 20, 2024
@erri120 erri120 added this to the v0.4 milestone Mar 20, 2024
@erri120 erri120 requested a review from a team March 20, 2024 14:17
@erri120 erri120 self-assigned this Mar 20, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 20, 2024

Codecov Report

Attention: Patch coverage is 16.66667% with 45 lines in your changes are missing coverage. Please review.

Project coverage is 54.18%. Comparing base (52df463) to head (1d0e894).
Report is 10 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1102      +/-   ##
==========================================
- Coverage   54.35%   54.18%   -0.17%     
==========================================
  Files         671      672       +1     
  Lines       22175    22256      +81     
  Branches     1708     1709       +1     
==========================================
+ Hits        12053    12060       +7     
- Misses       9724     9802      +78     
+ Partials      398      394       -4     
Flag Coverage Δ
Linux 53.45% <16.66%> (-0.20%) ⬇️
Windows 53.41% <16.66%> (-0.19%) ⬇️
clean_environment_tests 54.17% <16.66%> (-0.17%) ⬇️
macOS 53.00% <16.66%> (-0.13%) ⬇️
network_tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...cs/DiagnosticTemplateIncrementalSourceGenerator.cs 84.66% <100.00%> (-0.05%) ⬇️
...I/Controls/Diagnostics/DiagnosticEntryViewModel.cs 0.00% <ø> (ø)
...ions.Games.Diagnostics/Writer/IDiagnosticWriter.cs 0.00% <0.00%> (ø)
...p.UI/DiagnosticSystem/LoadoutReferenceFormatter.cs 0.00% <0.00%> (ø)
...s.App.UI/DiagnosticSystem/ModReferenceFormatter.cs 0.00% <0.00%> (ø)
....Games.Diagnostics/Writer/DiagnosticWriterState.cs 0.00% <0.00%> (ø)
...Mods.App.UI/DiagnosticSystem/NamedLinkFormatter.cs 0.00% <0.00%> (ø)
...usMods.App.UI/DiagnosticSystem/DiagnosticWriter.cs 0.00% <0.00%> (ø)
...sMods.Abstractions.Games.Diagnostics/Diagnostic.cs 23.33% <0.00%> (-3.59%) ⬇️
...rols/Diagnostics/DiagnosticEntryDesignViewModel.cs 0.00% <0.00%> (ø)

... and 8 files with indirect coverage changes

Copy link
Member

@Sewer56 Sewer56 left a comment

Choose a reason for hiding this comment

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

This is fine. Just extremely minor nitpicks.

Quick Question:

  • Is the Mode intended to be dynamically mutated?

Usually for code like this, I see a design where you have a writer for a specific 'mode' and then you invoke methods for that. This isn't a request to change the code, just curious more than anything.

@erri120
Copy link
Member Author

erri120 commented Mar 21, 2024

Quick Question:

* Is the `Mode` intended to be dynamically mutated?

Nope.

@erri120 erri120 merged commit 5220371 into Nexus-Mods:main Mar 21, 2024
6 checks passed
@erri120 erri120 deleted the feat/markdown-writer branch March 21, 2024 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic: Diagnostics This is related to the Diagnostic System
3 participants