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

Print a diff or explanation showing license rule or resolved expected license vs acutal upon failure #290

Open
astubbs opened this issue Jan 21, 2022 · 3 comments
Labels
in:core MLP core module is:feature New feature todo Accepted items from the backlog which can be worked on

Comments

@astubbs
Copy link

astubbs commented Jan 21, 2022

ATM the plug-in only says the header is missing in certain files. It would be great to instead show actual vs expected.

Example, say there's a single letter or number wrong. Useful for debugging issues. We've had a confusing issue with the latest year tick over where the year is expected to be changed, but when it is, it still fails. Could be a confusing issue with git file modification dates vs actual date etc.

Some more explanation of failure would be great. Although this may be difficult with the format of the templates etc.

@stale
Copy link

stale bot commented Mar 22, 2022

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward? This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale Inactive items that will be automatically closed if not resurrected label Mar 22, 2022
@dbwiddis
Copy link
Contributor

I think this is a good feature request. The spotless maven plugin does this. Currently when troubleshooting license rewrite failures I have no option other than to run license:format and use my IDE or other tools to examine the diff.

@stale stale bot removed the stale Inactive items that will be automatically closed if not resurrected label Mar 23, 2022
@mathieucarbou mathieucarbou added todo Accepted items from the backlog which can be worked on is:feature New feature in:core MLP core module labels Mar 26, 2022
@mathieucarbou
Copy link
Owner

@astubbs @dbwiddis : agree this would be a nice addition and not so hard to do I think.

Though, I wouldn't add that by default because it can be very verbose on a big project.

I would add a new option like verboseCheck or showCheckErrors, something like this, which, when activated, would display the formatted file header like if a format would have been called.

Note also that with the recently introduced license sets, where several license files can now be used for a different set of source files, this is even more appropriate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in:core MLP core module is:feature New feature todo Accepted items from the backlog which can be worked on
Projects
None yet
Development

No branches or pull requests

3 participants