@condenast/opensource-check

0.0.5 • Public • Published

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.

Package Sidebar

Install

npm i @condenast/opensource-check

Weekly Downloads

7

Version

0.0.5

License

Apache-2.0

Unpacked Size

47.5 kB

Total Files

23

Last publish

Collaborators

  • sreenu-condenast
  • ronjr_owlbear
  • boygao1992
  • saikat_conde
  • ashanatesh
  • priyadarshinitao
  • naresh.kandhan
  • deepakmohan
  • husnabushra
  • ramjeetm
  • imleodc
  • skumar3conde
  • mounika-boyapati
  • nagaraja_h
  • jasonmarlin
  • arunconde
  • roberlander
  • josemanuel.barea.ortiz
  • nprabhu-cn
  • sahildshah1
  • jmundycn
  • juliendevlin
  • sheetalparsa
  • unviradiya
  • ssingh417
  • dev-anand-94
  • vinitha_thiagarajan
  • prasil1107
  • rgunton-conde
  • swarupshankar
  • areadman
  • abhishek_pandey_cn
  • vchand-cn
  • harsh_condenast
  • swati_verso
  • samruddhidube24
  • gapurdev
  • akshayjain10
  • utkarsh24
  • suma_k
  • mohnish_vurity
  • piyush_das
  • kshitiz_choudhary
  • cnmanju
  • vvkudachi
  • vijeshrj
  • jkraus
  • vaseemakram
  • sharvanipatil
  • cn-rahul-tiwari
  • dhanashri027
  • mukarthik
  • blue-rigel
  • mguyromelle
  • bharathikarunanithi
  • cn_priyanka14
  • mehulpiruka
  • kishor-kumar07
  • ngsangeeta
  • prashant_singhparihar
  • snehak
  • shrutinivedita
  • sandhya_rani
  • cedric_mascarenhas
  • m-mallikarjuna
  • imran-conde
  • smantriconde
  • machelslackatcondenast
  • sachin-ns
  • jorge_guerra2
  • pratima_cn
  • harsha_mahadevaiah
  • richa_cn
  • karthik_cn
  • muthuprakashvelumani
  • imleo_conde
  • issanjana
  • a-rena
  • colin-alexa
  • bxh-io-cn
  • benknowlesnews
  • timklimowicz
  • ramkun
  • kamal_conde
  • aditijhacn
  • namansingh_bhandari
  • max-prin
  • cnarkhede
  • nrajeshnpm
  • vinothkumar_bala
  • aksingh5
  • shashank_jaiswal
  • saicharan7766
  • vineethd
  • hebsibal_selvaraj
  • akeshavamurthy
  • priyanka_jha
  • saniyashk
  • jbs-cn
  • gargi-c
  • hippolin
  • klnarayanan
  • cn_joy_sen
  • cn-andres
  • ganavi_j
  • sellapandi1998
  • jsharma-cn
  • spoorthi.chandrashekar
  • venkatesh547
  • dinakar25
  • hegdem
  • erikveland
  • asinghconde
  • joselee43
  • eunianina
  • gchaithra
  • patternwise
  • omar.wl
  • andrixb
  • raxs
  • vivekans
  • susel_retana
  • praveenppk
  • rafalpuche
  • conde_jode
  • subbiah_ramakrishna
  • fernandolara23
  • sarahshincn
  • jordi.escude
  • nnasirov
  • unnatik
  • tania.delatorre
  • mniewiera-cn
  • vinayashreeram
  • mohitsharma-news
  • aaaanti
  • psundar
  • wljoel
  • arhovale
  • sgdurham
  • fsanchezvilela
  • alfonsocondenast
  • rashmicn
  • slarty667
  • christinahara
  • nanjacn
  • siddhu-23
  • atp-engineering
  • katiasfihi
  • luisenriquegutierrez
  • akhil_npm_condenast
  • danj-cn
  • sudeshna_cn
  • vikash_cn
  • lakshmi.priya
  • sumanth_cn
  • shahu_cn
  • utsav_cn
  • mmorris9
  • maila-labib
  • mala-shanbhag
  • anilc93
  • lavishgambhir
  • vmanzanilla
  • tdscondenast
  • nitish-tandia
  • murali-condenast
  • alejandroaltf4dev
  • omsun22
  • ksriniva2
  • aleccuster_cn
  • andregcab
  • bhoopalt
  • niclasbork
  • pramita21
  • tchathur
  • kangkanbora
  • suhas-cn
  • vinay-pr
  • rjcn
  • vikramchowdary_parimi
  • sugumarv
  • josephrussell-cn
  • seking31
  • eliza.nieves
  • anaedzm
  • naveen1601
  • kajal-sikka
  • cn-connorbrannigan
  • prajwal_keshav
  • arjunpa
  • sharique10
  • babincondenast
  • cn-oramirez
  • guru05111984
  • subinjoeconde
  • edistel
  • saahithisri
  • balar20
  • s_dwivedi
  • nhrqz
  • monicar
  • richsancho
  • tanya-sah
  • cn_jenkins
  • frandevinney
  • renovate
  • jyoti_3009
  • r0r71z
  • jaemega
  • aman-shinde-07
  • condenastadmin
  • angrymongoose
  • copilot-robot
  • cry4dawn_2000
  • fennen529
  • fmadrie
  • gkilian
  • gmedina
  • bigzed
  • raagul-conde
  • stan
  • stanley
  • andi.anderson522
  • tamal_banerjee
  • davidkofahl
  • biku
  • taniabhullar
  • dkorenblyum
  • tollmanz
  • amalamchtal
  • tdshap
  • nidhi-tcs
  • rishutcs
  • sayeedcn
  • pitchfork-dev
  • danhaller
  • rajasinghcondenast
  • derrickatcn
  • tce
  • lboylan
  • cnid_engineering
  • lilyhealey
  • varun9110
  • megrymo
  • prajaktak
  • manthanbhosle
  • rutujavetal
  • niharanil
  • psharma2
  • bhumikakhatri
  • sarthak_mohanty
  • igostu
  • rajashreearvikar19
  • tobe998
  • cwoldt
  • ndi
  • nishkala
  • sahana2104
  • mladhane
  • mtzhang
  • manthanraut
  • jfrederick12
  • rajashree-devaraj
  • sdconde
  • rigelsong
  • drosenbaum
  • roopeshrkn
  • aswani_gupta
  • garryyao
  • charuagrawal
  • sabarni-condenast
  • yakshita
  • kalyanikasar
  • talk2rajeev
  • shreyapa
  • stefanpenner
  • natelawscn
  • bbui
  • alexli
  • brian_mathews
  • crmartin
  • leahzxxz
  • hmehta06
  • srigurutcs
  • husheric
  • katemont
  • eddleston
  • rtt
  • eshno
  • jcorcino
  • anwaukoni
  • richardsjustind
  • eduardoveras
  • mrgentax
  • thehiddenhaku
  • cl4m
  • spollini
  • fedeava
  • sasha04
  • guidop91
  • gostfield
  • nithya10
  • satnam_gandhi
  • abigaild45
  • mb_dev
  • rmohamma
  • emilyatk
  • asolovyev
  • vaishnavisenthilvel
  • stefano-sarioli
  • sarah-chekfa
  • luis_gomez
  • danielbaldwin
  • karmenn
  • khiaraortiz
  • dmitriy_komarov-cn
  • jhraue
  • sviatoslav_maslov
  • hcet
  • jmcamacho
  • ishita_tiwari
  • sanjana_s
  • hariprasath_cn
  • harinikiruba
  • condenastfr
  • iamsuneeth
  • suhitrathi-condenast
  • zeeshan-wani
  • imakshath
  • srikanthns
  • mitchellstewart
  • pushp-1992
  • anoopk-cn
  • mithunsathyanmits
  • surbhi_cn
  • vikasshetty
  • midhunmurali001
  • sudiptacondenast
  • salvador-ahumada
  • suba56
  • skt-dev
  • ganeshnca
  • belal_kazmi
  • rszmacinski
  • prakashn37
  • utkarsh_sanjivan-conde
  • mallica
  • shobith
  • rashmi-rao
  • sahoo.sandhya
  • sardendu
  • agururajan
  • skumari
  • sikindar_mirza
  • ankitkumar02
  • avinash_iitb
  • upenpanging
  • speluri
  • anubalakrishnan
  • sbhattac
  • rjain198
  • ashwini_uppar
  • pmasade
  • jbergdol
  • suresharam
  • vnallasa
  • dhanraj_cn
  • pratik-gupta
  • anita-y
  • arvipandey
  • sandesh4777
  • vishnusimvisfear
  • ilankumaran
  • samtiffin
  • harsha-condenast
  • adityaanand534
  • rkamble
  • chandan-condenast
  • pratham7674
  • alokreddycn
  • anurag-cn
  • odtoribio
  • pranjal_sharma306500
  • vijayalakshmi-sunagar
  • helena-ong
  • namankumarsinha
  • grannitsejdiu
  • rkharecondenast
  • sumitmaurya21
  • pashoka
  • shubham_condenast
  • sourav_condenast
  • tanmoy_condenast
  • nidhiarya-condenast
  • vmehrotr
  • smita2022
  • pariharcondenast
  • subiabre
  • snehadg
  • sourav909
  • surabhidesai
  • syed_faizan
  • raveena-ram
  • statavar
  • jatinbabbarcondenast
  • ankushvijay93
  • likhita
  • indu-sagi
  • jakir-coder
  • priyankanandi
  • nikhilcondenast
  • stahirah
  • sparganiha-cn
  • aswanth_condenast
  • vinay_kumar
  • rajeswari-cn
  • soumyagundu
  • cnrahulrkr
  • ramya-cn
  • dikshita_khandke
  • somsekhardash
  • ambay_chaurasia
  • manikandancn
  • rghvndr99
  • shubhamkheracn
  • akhil_pasham
  • mulla2
  • spandey10
  • srawat-cn