Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@guidesmiths/license-checker

Package Overview
Dependencies
Maintainers
5
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@guidesmiths/license-checker

License checker for GuideSmiths projects

  • 1.2.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2K
increased by58.16%
Maintainers
5
Weekly downloads
 
Created
Source

@guidesmiths/license-checker

All Contributors

License checker for GuideSmiths projects

Roadmap:

https://github.com/guidesmiths/license-checker/issues/29

Description

This package allows you to do a quick audit on your NPM dependencies by adding it in your hooks.

You can optionally add options to exclude generating the report or avoid generating the error report in case a forbidden license is found (see more details here)

How to use it in your project

  • Install the package
npm install @guidesmiths/license-checker
  • Add a script to run the package
npx @guidesmiths/license-checker --failOn license1,license2
  • Use the script wherever you want (husky hook, in your CI/CD pipeline, ...)

Options

OptionDescriptionTypeDefault
--startPath of the initial json to look forstringprocess.cwd()
--versionShows the version of the packageboolean
--failOnFail (exit with code 1) on the first occurrence of the licenses of the comma-separated liststring
--generateOutputOnGenerates an output file only if any the licenses of the comma-separated list exist (output generated by default)string
--outputFileNameName of the output file generatedstringlicense-report-<timestamp>.md
--errorReportFileNameName of the file generated when a license in the failOn option is foundstringlicense-error-<timestamp>.md
--disableErrorReportFlag to disable the error report file generationbooleanfalse
--disableReportFlag to disable the report file generation, whether there is an error or notbooleanfalse
--customHeaderName of a text file containing the custom header to add at the start of the generated reportstring
-h, --helpShows helpboolean

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Jose Manuel Torralvo Moyano

💻 📖 🤔 🚧 👀

Mario Quiroga

💻 📖 🤔 🚧 👀

Íñigo Marquínez

💻 📖 🤔 🚧 👀

Sara Hernández

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Keywords

FAQs

Package last updated on 08 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc