-
Notifications
You must be signed in to change notification settings - Fork 34
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
Add a --clarificationFile option #64
Add a --clarificationFile option #64
Conversation
This commit adds a --clarificationFile option, modeled after the behavior of `cargo-about`. It allows users to specify clarifications for specific packages and versions with missing or otherwise malformed fields.
On further usage, I think it would be better to make the checksum field optional. I'm used to Cargo's packaging norms and NPMs aren't as standardized unfortunately :( |
Wow, this is by far the best PR I've seen so far for this project since I forked it from the original license-checker - thank you so much! Getting back to this PR soon & cheers, |
Hey Roman, Enjoy your holiday with your family, no rush to merge this PR! I have already pointed our internal builds at my fork branch so we're humming along just fine :) Hope the skiing shreds 😄 |
In attempting to use this I found a need to snip out portions of the license from other embedded files. I have added the relevant functionality as well as some more documentation for the new features :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @mikayla-maki, once more thank you so much for your great contribution!
I have 3 really minor change requests of a purely aesthetic nature, I hope you don't mind.
I currently still struggle with setting up a proper Prettierjs and ESlint configuration that works seamlessly with the Sublime Text 4 setup I am using here, which will - should it work - demand single quotes rather than double quotes where applicable, but I hope this will not be an issue here for now.
What also irritates me is the fact that PRs come from foreign repositories, but that's a thing I have to learn, as it's the usual way things go in open source world. So maybe I handle things a bit strangely from time to time, but I hope my workflow and the project's documentation will improve over time.
That being said: I'm always open for questions and suggestions.
Cheers, Roman.
@RSeidelsohn Aesthetic changes implemented! Thank you for the feedback :D |
While building out my company's automated licensing compliance code I attempted to use this project to implement automated monitoring for our project's compliance with the
--onlyAllow
flag. However, several of our dependencies (e.g.@contentlayer/cli@0.3.0
) have anUNKNOWN
license. I could not find a way to add package specific overrides with this project, so I decided to contribute to this project :).This PR adds a --clarificationFile option, modeled after the similar behavior in
cargo-about
. This allows users to specify custom overrides for specific packages with missing or otherwise malformed fields. I also added tests for the feature, aclarificationExample.json
file to show how it should work, and ensured that code coverage stayed within the project's limits.Let me know if there's anything else I can do for this PR, and thank you for maintaining such a vital project!