Make markdown reporter more diff friendly #326
+75
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Disabling timestamp and counter output makes the report more diff friendly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The markdown report is a convenient because it is nice to read when rendered to html but its source is also nice to read when compared to html report, for example. The markdown report can also be added to version control in order to track and verify changes to licenses.
However, the timestamp and counter values included in the report make it unfriendly for diffing. For example, adding or removing a dependency may cause tens or hundred of modified lines in a diff.
I propose we make it configurable if timetamp or counter values should be included in the report. This is what I have implemented in this pull request. The change should be backwards compatible because the default values are such that the timestamp and counter values are included in the report.