Give credit to syntax definition and theme authors with new --acknowledgements option#1971
Merged
Enselic merged 9 commits intoDec 11, 2021
sharkdp:mastersharkdp/bat:masterfrom
Enselic:acknowledgements-optionEnselic/bat:acknowledgements-optionCopy head branch name to clipboard
Merged
Give credit to syntax definition and theme authors with new --acknowledgements option#1971Enselic merged 9 commits intosharkdp:mastersharkdp/bat:masterfrom Enselic:acknowledgements-optionEnselic/bat:acknowledgements-optionCopy head branch name to clipboard
--acknowledgements option#1971Enselic merged 9 commits into
sharkdp:mastersharkdp/bat:masterfrom
Enselic:acknowledgements-optionEnselic/bat:acknowledgements-optionCopy head branch name to clipboard
Conversation
Enselic
commented
Dec 5, 2021
--acknoledgements option--acknowledgements option
…ledgements` option The text that is printed is generated when building assets, by analyzing LICENSE and NOTICE files that comes with syntaxes and themes.
Enselic
force-pushed
the
acknowledgements-option
branch
from
December 5, 2021 16:34
a647069 to
1d72508
Compare
keith-hall
approved these changes
Dec 7, 2021
sharkdp
approved these changes
Dec 8, 2021
Collaborator
Author
|
Ok, all comments taken care of. Here is how the output looks now: Full output |
sharkdp
approved these changes
Dec 9, 2021
keith-hall
approved these changes
Dec 9, 2021
This file contains hidden or 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
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 text that is printed is generated when building assets, by analyzing LICENSE and NOTICE files that comes with syntaxes and themes. If an unknown license is encountered, an error is raised, which will e.g. cause CI to fail.
Currently the
acknowledgements.binfile is generated when passing--blanktobat cache --build, which we notably do in ourcreate.shscript. So it should not affect regular users. We might want to also require--acknowledgementsto be passed, like this:bat cache --build --blank --acknowledgements ...to really rule out accidental invocation. (Edit: After thinking about it some more I pushed a commit for that.) There is no point in messing around with acknowledgements when users build custom assets. In fact, the output of--acknowledgementsshould be the same, regardless of if custom assets are used or not.I have not done super thorough verification of this PR, but I consider it sophisticated enough to warrant opening a PR for it and discuss high level aspects of it.
It is possible to imagine bells and whistles on this, like smarter text wrapping of the output, or automatic invocation of the pager, but I would prefer to not do that in this MVP PR.
Current output of `bat --acknowledgements` (click to expand)