npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@procore/license-check

v2.0.1

Published

Validates that packages use correctly-licensed npm packages.

Downloads

64

Maintainers

squidbeakssquidbeaksswati.jadhavswati.jadhavtejeshwartejeshwarmohitsharma97mohitsharma97andreszorrilla-procoreandreszorrilla-procoremagdyyxxmagdyyxxcharan_procorecharan_procorealy-el-kerdanyaly-el-kerdanys_kudryks_kudrykadarsh.gautamadarsh.gautamvishal-procorevishal-procorekalyani.gosavikalyani.gosaviamit.gurav-contractoramit.gurav-contractorworldofsatyakiworldofsatyakikuldeepsingh4556kuldeepsingh4556karina.mendez-contractorkarina.mendez-contractorbikash.sahoobikash.sahoorowan.ibrahimrowan.ibrahimvinayakaprabhuvinayakaprabhusaurasumprocoresaurasumprocoreconner-procoreconner-procorechaitra-m-15chaitra-m-15vsobol-cvsobol-cabhishekkumar123abhishekkumar123jasaswinijasaswinialeh.haurylenia-contractoraleh.haurylenia-contractorkellikearnskellikearnsviktoriia_azarovskaviktoriia_azarovskafabriciobdfabriciobdyoussefameryoussefamerbrockpcorbrockpcorkani-procorekani-procoreantonyayoubantonyayoubashish.sharma2024ashish.sharma2024glidenorglidenordaniel-pierre-procoredaniel-pierre-procoreamitk030amitk030mathenes_procoremathenes_procorevinoth.kuppusamyvinoth.kuppusamymariia.solodovnikmariia.solodovniksflang-procoresflang-procorecassianomatos-procorecassianomatos-procorealan.facchini-contractoralan.facchini-contractorzayterzayterbohdan-horai-procorebohdan-horai-procorenigeld-procorenigeld-procoresamad.viranisamad.viranifernandocamilottifernandocamilotticonnie-feng-procoreconnie-feng-procoreroger-procoreroger-procoreganesh.raghupathyganesh.raghupathyyzhou2024yzhou2024alyelashram_procorealyelashram_procoremelch-procoremelch-procorepeterknifpeterknifmoaz-ashrafmoaz-ashrafattachiattachia.elbadaweia.elbadaweihyogmanhyogmandmitri_wmdmitri_wmstephanie.breretonstephanie.breretonprocore-oss-userprocore-oss-userstevenkang3stevenkang3max.helmetagmax.helmetagcodyrobertsprocorecodyrobertsprocoremiguel.garcia-procoremiguel.garcia-procoreatoaimaatoaimamustafa-abdelrahmanmustafa-abdelrahmanelewando-procoreelewando-procoreahmed.ghorabahmed.ghorablnspatz914lnspatz914richard.bunnrichard.bunnomar.wagdyomar.wagdymona.khairbekmona.khairbekmbartlett413mbartlett413cody_schindler_procorecody_schindler_procoreyoasyo25yoasyo25ritchleeritchleeandersontr15andersontr15steven.hinklesteven.hinklejamie-dugan-procorejamie-dugan-procorehgouhierprocorehgouhierprocoredenzylbalramdenzylbalramsarah.freitassarah.freitasalan.bresanialan.bresaniamyprocoreamyprocoreyoyis3000yoyis3000elijah.procoreelijah.procoremike-arndt-procoremike-arndt-procorejnhoang1jnhoang1pam-whisenhuntpam-whisenhuntshradha.khardshradha.kharddavid-christensen-procoredavid-christensen-procorejavio-procorejavio-procorechance.eakin.procorechance.eakin.procoregideon-procoregideon-procoreihor.diachenko_procoreihor.diachenko_procorejustinmwattsjustinmwattstedyangtedyangjyang-procorejyang-procorepwhisenhunt-procorepwhisenhunt-procorefairchildfairchildrodayna.ehabrodayna.ehabneil1023neil1023scottsternscottsternbrian.smith1brian.smith1g2mitchellg2mitchelldlameter-procoredlameter-procorekylepietzkylepietzabhijit-procoreabhijit-procorelhuang325lhuang325jake-pitkinjake-pitkinerikthoresonerikthoresonsimona.iancusimona.iancudecha-sansondecha-sansonaberkowitzaberkowitzasamayasamaymustafa-u-abdelrahmanmustafa-u-abdelrahmanrajatmenhdirattarajatmenhdirattajacksonleach-procorejacksonleach-procorepmfrawleypmfrawleyphunguyen-pcorphunguyen-pcortatsiana.cliftontatsiana.cliftondeiabdeiabsrichaitanya.peddintisrichaitanya.peddintikenny.foisykenny.foisymatheusprocorematheusprocorejgreene_procorejgreene_procorehectorthielehectorthieleetokarevetokarevdaniel.ferreira-contractordaniel.ferreira-contractordmccraw-procoredmccraw-procorecyrille.baicyrille.baigreg.sparksgreg.sparksfabiomelo513fabiomelo513phil.custerphil.custerbbreyel921bbreyel921amir-iskanderamir-iskanderneil.mckeemanneil.mckeemannickprocorenickprocorelzhou888lzhou888davidshuredavidshurestevenliprocorestevenliprocoreramysaid2ramysaid2refaiepcnrefaiepcnjgentesjgentesfaraz.haniffaraz.hanifmostafaeltazymostafaeltazyagamaleldinagamaleldinandrew.isaacandrew.isaacsaranahal2saranahal2rodrigo.dejuanarodrigo.dejuanakellen.stewartkellen.stewartbill-wagnerbill-wagnerezrasimeloffezrasimeloffjeffgiaquintojeffgiaquintogturkadzegturkadzesean.spearman.procoresean.spearman.procorekylemartinez-procorekylemartinez-procoreroobo-romeskiroobo-romeskiandres-mendez-procoreandres-mendez-procoregaurav.sharma.procoregaurav.sharma.procoretracy.ottotracy.ottosarah.herediasarah.herediavictorbendeck-pcvictorbendeck-pccbathgatecbathgatedavidkangprodavidkangprokyle.liukyle.liuamin.jaipuriamin.jaipurigrafffffffgrafffffffmishaelowoyemimishaelowoyemievan.cerwonka.procoreevan.cerwonka.procoreilya.dryha-contractorilya.dryha-contractorvaromirvaromiryogevfine1yogevfine1timofeeetimofeeematt.harris0223matt.harris0223winson.chuwinson.chuandersonbispoprocoreandersonbispoprocorescorgiat-procorescorgiat-procoreladavargaladavargaprocore_halzyprocore_halzyenyagaenyagawillpankonienwillpankoniensateesh-kadiyala-procoresateesh-kadiyala-procorechris.berberchris.berbertxin1txin1epalinprocoreepalinprocoremehrdad-panahandehmehrdad-panahandehtyler.wasden.procoretyler.wasden.procorejeremy.lundjeremy.lunddineshkumar.jayakdineshkumar.jayakryanfuentesprocoreryanfuentesprocorestajicsstajicsbrocktillotsonprocorebrocktillotsonprocorekyle.williamskyle.williamsdtorres-procoredtorres-procorenoor.alinoor.aliari-procoreari-procorealanprocorealanprocorejl4everjl4everjames.lawsonjames.lawsonajaykumar-procoreajaykumar-procoredennis.heckmandennis.heckmanlalovar-procorelalovar-procorejames.clearyjames.clearychadryderchadryderdevin.cunningham.procoredevin.cunningham.procoreabhijit.patwardhanabhijit.patwardhanlydiaharalydiaharasherylnapigkitsherylnapigkitchangprocorechangprocoreapcarroll_procoreapcarroll_procoreandy.mayerandy.mayerbob.laskowskibob.laskowskivinaya-procorevinaya-procorekahliholmeskahliholmesandrew.wheelerandrew.wheelerleandro-procleandro-procyadhu.prakashyadhu.prakashjason-kayejason-kayejesse.olsenjesse.olsenpatrick.lardinpatrick.lardinbrad.uranibrad.uraniallenanle.procoreallenanle.procorebrookyboy009brookyboy009uddhavjoglekaruddhavjoglekardancingshelldancingshellrysmithprocorerysmithprocorerobbiegprocorerobbiegprocorejadamsssjadamsssjeremy.bouzigardjeremy.bouzigardtimdohertytimdohertyb.bookoutb.bookoutjalyngjalynghtaelhtaeldev-account-admindev-account-adminsseanwangsseanwangbhargavrndbhargavrndfarismmkfarismmkdannyporrellodannyporrellodanny.oudanny.oumessanjahmessanjaheyvettesoueyvettesoujgee67jgee67cagmzcagmzmariah_delaneymariah_delaneylukenispellukenispelkimhin267kimhin267juliana.hernandezjuliana.hernandezjudy-lu-pcjudy-lu-pcprocore-it-supportprocore-it-supportandrewburke-pcandrewburke-pcjkleintechjkleintechrachel.arkebauerrachel.arkebauerprocore-npm-botprocore-npm-botjames.dabbs-procorejames.dabbs-procorelaurenbrandsteinprocorelaurenbrandsteinprocorescottbieser-procorescottbieser-procorezach.mckenzie.procorezach.mckenzie.procoreshayonj_procoreshayonj_procoreheplayskeysheplayskeysmike.southmike.souththomasoboylethomasoboyledischordedischordederek-carter-procorederek-carter-procoredlgasserdlgassercfprocorecfprocoreevan.waitsevan.waitsjeremy-marcusjeremy-marcusjmejia-fsljmejia-fslersgonzaloersgonzalostephan-procorestephan-procorealeclarsenprocorealeclarsenprocoreyihai.zweifelyihai.zweifeljay-rajanjay-rajanjacky-leijacky-leipeter.jinpeter.jin

Readme

@procore/license-check

Validates that the licenses of a project do not violate Procore's software license requirements. Works for both monorepos as well as single-module projects.

Quick Start

This package can either be installed in a project or run directly using npx/pnpx. Additionally, the package provides an API that can be invoked in code.

yarn add -D @procore/license-check # or npm, pnpm

Then run the command:

yarn license-check check
npx @procore/license-check check

Install in project

yarn add -D @procore/license-check # or npm, pnpm

Then use!

import { checkLicenses } from '@procore/license-check'

const startDir = process.cwd()
const forbiddenLicenses = ['GPL-3.0-only']

await checkLicenses(startDir, forbiddenLicenses)

CLI Commands

Usage:
  $ license-check

Commands:
  check [startDir]  license check


For more info, run any command with the `--help` flag:
  $ license-check check --help
  $ license-check --help

Options:
  -h, --help     Display this message
  -v, --version  Display version number

API Methods

checkLicenses(startDir: string, forbiddenLicenses?: Array<string>): Promise<Array<{ name: string; invalid: Array<string>}>>

Returns a list of each workspace in project, along with which licenses are invalid

Parameters:

  • startDir: string: the root directory of the project to evaluate.
  • forbiddenLicenses: Array<string> (defaults to Procore's forbidden licenses): the list of licenses that should be considered invalid.

Returns:

An array of results objects containing the following properties:

  • name: string: the name of the project, as specified in its package.json file.
  • invalid: Array<string>: the package names and versions that violated the license check.
import { checkLicenses } from '@procore/license-check'

const startDir = process.cwd()
const results = await checkLicenses(startDir)

checkLicensesCLI(startDir: string, forbiddenLicenses?: Array<string>): Promise<void>

Executes the license, and formats the output into an easy-to-read format.

Parameters:

  • startDir: string: the root directory of the project to evaluate.
  • forbiddenLicenses: Array<string> (defaults to Procore's forbidden licenses): the list of licenses that should be considered invalid.

NOTE:

  • If there are invalid licenses, the output will be written to stderr, and program will exit with an exit code of -1.
  • If all licenses are valid, and short message will be output to stdout.
import { checkLicensesCLI } from '@procore/license-check'

const startDir = process.cwd()
await checkLicensesCLI(startDir)

Development

This project uses pnpm, and supports the following commands:

  • build: builds and bundles the project.
  • format: runs prettier on the project.
  • test: runs the unit test suite, reporting coverage.
  • test:dev: run the unit test suite in watch mode.