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

Introduce --about command for printing Open Source attributions #3555

Merged
merged 3 commits into from
Aug 8, 2022

Conversation

JackuB
Copy link
Contributor

@JackuB JackuB commented Aug 5, 2022

Ever since Snyk CLI started bundling its npm packages, we generated an attributions file that was part of the npm package we distributed.

However, since we also distribute single executables, we should expose the attribution information from the CLI interface itself. This PR introduces an --about option, with a same importance as --version. This option will print out the license information if libraries bundled into the Snyk CLI. I chose about as a command name following an SO thread.

Screen Shot 2022-08-05 at 14 32 59

Since thirdPartyNotice.json is now a runtime dependency, this PR also moves the file generation step to the main webpack config file.

And manually fill in slice-ansi license text

Signed-off-by: Jakub Mikulas <jakub@snyk.io>
To satisfy Open Source licenses requirements when compiling Snyk CLI into a single binary

Signed-off-by: Jakub Mikulas <jakub@snyk.io>
Signed-off-by: Jakub Mikulas <jakub@snyk.io>
@JackuB JackuB requested review from a team as code owners August 5, 2022 12:37
@github-actions
Copy link
Contributor

github-actions bot commented Aug 5, 2022

Warnings
⚠️

Since the CLI is unifying on a standard and improved tooling, we're starting to migrate old-style imports and exports to ES6 ones.
A file you've modified is using either module.exports or require(). If you can, please update them to ES6 import syntax and export syntax.
Files found:

  • src/cli/args.ts
  • webpack.common.ts
Messages
📖

You are modifying something in test/smoke directory, yet you are not on the branch starting with smoke/. You can prefix your branch with smoke/ and Smoke tests will trigger for this PR.

Generated by 🚫 dangerJS against 98506fa

@JackuB JackuB merged commit 915e045 into master Aug 8, 2022
@JackuB JackuB deleted the feat/about-command branch August 8, 2022 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants