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

sverweij / dependency-cruiser

Validate and visualize dependencies. Your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

https://npmjs.com/dependency-cruiser

MIT License

5.15k stars 249 forks source link

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

Closed sverweij closed 7 months ago

sverweij commented 7 months ago

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?

[x] green ci
[x] additional non-regression tests

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] Documentation only change
[x] 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

[x] :book:
- My change doesn't require a documentation update, or ...
- it does and I have updated it
[x] :balance_scale:
- 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.

codeclimate[bot] commented 7 months ago

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

View more on Code Climate.