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

@condenast/opensource-check

v0.0.5

Published

Test Runner for Open Source Conventions

Downloads

115

Maintainers

cnjuandelgadillocnjuandelgadilloalexcostacondenastalexcostacondenastsarika_devinenisarika_devinenianil.kumag-ganil.kumag-gsarthak_mohantysarthak_mohantyunviradiyaunviradiyaselvakumar_sampathselvakumar_sampathcnmanjucnmanjuponchosbponchosbalokreddycnalokreddycnmohnish_vuritymohnish_vuritykishor-kumar07kishor-kumar07nbentoncondenbentoncondeshrutiniveditashrutiniveditannagle2nnagle2yarramanoharyarramanoharnitish-tandianitish-tandiajoselee10012024joselee10012024subhash453subhash453nikhilcondenikhilcondeanshul2025anshul2025manjunath_condemanjunath_condedavidstockercondenastdavidstockercondenastramjeetmramjeetmsimeon455simeon455vchand-cnvchand-cnmdmohsinmdmohsinshobhit0309shobhit0309shailvishuklashailvishuklaguru05111984guru05111984vijay-mallikvijay-mallikanarayanananarayananbhavin_condebhavin_condecedric_mascarenhascedric_mascarenhasvkudachivkudachishaik_tasneemshaik_tasneemyogeshwari_sevugarathinamyogeshwari_sevugarathinambhoopaltbhoopaltsahana2104sahana2104suhas-cnsuhas-cnvishu_1007vishu_1007shashank_jaiswalshashank_jaiswalndindirdevarajrdevarajsureneskandarpoursureneskandarpourtamal_banerjeetamal_banerjeejfrederick12jfrederick12timklimowicztimklimowiczvishal_ravivishal_ravirajeshs32rajeshs32vmishra2305vmishra2305deepak_mohandeepak_mohangshankar-ingshankar-inpradeep_nayakpradeep_nayaksabarni-condenastsabarni-condenastdev-anand-94dev-anand-94anubalakrishnananubalakrishnannaveen1601naveen1601sheetalparsasheetalparsavishnusimvisfearvishnusimvisfearvgoelvgoelvinayashreeramvinayashreerammitchellstewartmitchellstewartnhrqznhrqzsnehaksnehakraveena-ramraveena-ramankitkumar02ankitkumar02swati_versoswati_versonoman-cnnoman-cnsaahithisrisaahithisriprasil1107prasil1107imran-condeimran-condesaniyashksaniyashkmithunsathyanmitsmithunsathyanmitssanjana_ssanjana_sjyoti_3009jyoti_3009rajashreearvikar19rajashreearvikar19mala-shanbhagmala-shanbhagac432ac432ssingh417ssingh417nvillatonvillatoricardofbarrosricardofbarrosspelurispeluritdscondenasttdscondenastomsun22omsun22midhunmurali001midhunmurali001saicharan7766saicharan7766suhitrathi-condenastsuhitrathi-condenastdkorenblyumdkorenblyumbbuibbuitejasvi-bgtejasvi-bgvnallasavnallasavikas-scvikas-scskumar7skumar7cyrilpanicker-condenastcyrilpanicker-condenastboygao1992boygao1992saikat_condesaikat_condejasonmarlinjasonmarlinaruncondearunconderoberlanderroberlandernprabhu-cnnprabhu-cnjuliendevlinjuliendevlinvinitha_thiagarajanvinitha_thiagarajanareadmanareadmansamruddhidube24samruddhidube24gapurdevgapurdevakshayjain10akshayjain10utkarsh24utkarsh24suma_ksuma_kcn-rahul-tiwaricn-rahul-tiwaridhanashri027dhanashri027bharathikarunanithibharathikarunanithicn_priyanka14cn_priyanka14prashant_singhpariharprashant_singhpariharm-mallikarjunam-mallikarjunamachelslackatcondenastmachelslackatcondenastkarthik_cnkarthik_cnmuthuprakashvelumanimuthuprakashvelumaniissanjanaissanjanaa-renaa-renacolin-alexacolin-alexanamansingh_bhandarinamansingh_bhandaricnarkhedecnarkhedehebsibal_selvarajhebsibal_selvarajakeshavamurthyakeshavamurthypriyanka_jhapriyanka_jhaklnarayananklnarayananspoorthi.chandrashekarspoorthi.chandrashekarasinghcondeasinghcondeeunianinaeunianinaraxsraxsvivekansvivekansconde_jodeconde_jodejordi.escudejordi.escudennasirovnnasirovunnatikunnatikarhovalearhovalerashmicnrashmicnsiddhu-23siddhu-23atp-engineeringatp-engineeringdanj-cndanj-cnmaila-labibmaila-labibksriniva2ksriniva2andregcabandregcabtchathurtchathurkangkanborakangkanboravinay-prvinay-prjosephrussell-cnjosephrussell-cnanaedzmanaedzmcn-connorbrannigancn-connorbranniganprajwal_keshavprajwal_keshavbabincondenastbabincondenastedisteledistelfrandevinneyfrandevinneyrenovaterenovatecondenastadmincondenastadmincopilot-robotcopilot-robotfennen529fennen529fmadriefmadriegmedinagmedinabigzedbigzedbikubikujoshcondenastjoshcondenastrashmi-raorashmi-raoimakshathimakshathnishkalaadiganishkalaadiganiharanilniharanilkatiasfihivoguekatiasfihivogueprakashn37prakashn37andi.anderson522andi.anderson522davidkofahldavidkofahltollmanztollmanzamalamchtalamalamchtaltdshaptdshapdanhallerdanhallerrajasinghcondenastrajasinghcondenastderrickatcnderrickatcntcetcecnid_engineeringcnid_engineeringlilyhealeylilyhealeymanthanbhoslemanthanbhoslepsharma2psharma2bhumikakhatribhumikakhatriigostuigostucwoldtcwoldtmtzhangmtzhangmanthanrautmanthanrautdrosenbaumdrosenbaumaswani_guptaaswani_guptayakshitayakshitakalyanikasarkalyanikasarshreyapashreyapanatelawscnnatelawscnleahzxxzleahzxxzkatemontkatemonteddlestoneddlestonrttrttanwaukonianwaukonieduardoveraseduardoverasmrgentaxmrgentaxcl4mcl4mspollinispollinifedeavafedeavaguidop91guidop91nithya10nithya10mb_devmb_devemilyatkemilyatkluis_gomezluis_gomezkarmennkarmennkhiaraortizkhiaraortizdmitriy_komarov-cndmitriy_komarov-cnjmcamachojmcamachohariprasath_cnhariprasath_cnsrikanthnssrikanthnssudiptacondenastsudiptacondenastutkarsh_sanjivan-condeutkarsh_sanjivan-condemallicamallicaagururajanagururajanupenpangingupenpangingrjain198rjain198ashwini_upparashwini_upparpmasadepmasadesuresharamsuresharamdhanraj_cndhanraj_cnpratik-guptapratik-guptasamtiffinsamtiffinadityaanand534adityaanand534chandan-condenastchandan-condenastvijayalakshmi-sunagarvijayalakshmi-sunagarnamankumarsinhanamankumarsinhaankushvijay93ankushvijay93likhitalikhitapriyankanandipriyankanandisoumyagundusoumyagunduramya-cnramya-cndikshita_khandkedikshita_khandkeambay_chaurasiaambay_chaurasiamanikandancnmanikandancnrghvndr99rghvndr99mulla2mulla2

Readme

OpenSource Check ✅

A Test Runner for verifying Open Source conventions in JavaScript projects

license

Proudly built by:

Pre-Requisites

This utility can currently only be used for JavaScript/Node projects.

Install

This utility can be used as a temporary dependency, global dependency or a dev dependency.

Head over to the usage section below on how to set it up based on your preference.

Usage

Parameters

The utility accepts the following parameters:

  • --path - to specify the path of your project directory (defaults to current working directory)
  • --org - to specify the npm organization namespace for your project

Usage as a temporary dependency

This is great option for taking this a quick spin!

npx @condenast/opensource-check --path <your-project-path>
npx @condenast/opensource-check --path ./glamorous
npx @condenast/opensource-check --path ./xml-to-react --org condenast

Usage as a global dependency

This is a good option if you plan to use this frequently but don't want it to be a part of your project setup.

npm install -g @condenast/opensource-check

opensource-check --path <your-project-path>
opensource-check --path ./glamorous
opensource-check --path ./xml-to-react --org condenast

Usage as a dev dependency

This is a wonderful option if you plan to use this as part of your project workflow including using in CI environment.

npm install -D @condenast/opensource-check

npx @condenast/opensource-check --path <your-project-path>
npx @condenast/opensource-check --path ./glamorous
npx @condenast/opensource-check --path ./xml-to-react --org condenast

Screenshot

This is a sample screenshot of running this utlility:

Checklist

The current checklist of things that are verified by the utility on every run:

Documentation

  • [ ] Has a README
    • [ ] Has a Title
    • [ ] Has an Install section
    • [ ] Has a Usage section
  • [ ] Has a License
  • [ ] Has a Code of Conduct
  • [ ] Has Contributing Guidelines
  • [ ] Has an Issue template
  • [ ] Has a Pull Request template
  • [ ] Has a Changelog
  • [ ] Has Examples

Development

  • [ ] Has a package.json
    • [ ] Has org namespace, if applicable
    • [ ] Has a version
    • [ ] Has a description
    • [ ] Has a main or bin
    • [ ] Has a link to git repository
    • [ ] Has contributors
    • [ ] Has a license
  • [ ] Has a .gitignore
  • [ ] Has a linter
  • [ ] Has a test runner

Boilerplate

These documents are provided under the boilerplate directory for use by any project:

  1. LICENSE.md - Apache 2.0
  2. CODE_OF_CONDUCT.md - Contributor Covenant v1.4
  3. CONTRIBUTING.md - (inspired from Atom and Rails)
  4. ISSUE_TEMPLATE.md
  5. PULL_REQUEST_TEMPLATE.md
  6. README.md

Projects that Checked-Out!

This is a list of projects that pass the Open Source Checks:

Thanks

We were inspired by the ideas and code of the following projects:

Contributors

See the list of contributors who participated in writing this tool.