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

refactor(cli|report): moves responsibility to ensure output ends with an EOL to the individual reporters #908

Merged
merged 2 commits into from
Feb 3, 2024

Conversation

sverweij
Copy link
Owner

@sverweij sverweij commented Feb 3, 2024

Description

  • moves responsibility to ensure output ends with an EOL to the individual reporters
  • adjusts most reporters to emit an EOL (except the null reporter, which exists to emit nothing but null)
  • adds a unit test that guarantees current & future reporters will still have an EOL in their output

Motivation and Context

Fixes a personal OCD issue where the null reporter emitted an EOL disturbing adding an empty line to the diagnostics reporter (I see that thing a lot ...).

Drawback: this solution is less simple/ elegant than the previous one (see diff).

How Has This Been Tested?

  • green ci
  • additional non-regression tests

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation only change
  • Refactor (non-breaking change which fixes an issue without changing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • 📖

    • My change doesn't require a documentation update, or ...
    • it does and I have updated it
  • ⚖️

    • The contribution will be subject to The MIT license, and I'm OK with that.
    • The contribution is my own original work.
    • I am ok with the stuff in CONTRIBUTING.md.

Copy link

codeclimate bot commented Feb 3, 2024

Code Climate has analyzed commit cf36cb3 and detected 0 issues on this pull request.

View more on Code Climate.

@sverweij sverweij merged commit b592264 into main Feb 3, 2024
9 checks passed
@sverweij sverweij deleted the refactor/de-centralize-eol-guarantee branch February 3, 2024 19:07
This pull request was closed.
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.

1 participant