@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

12

Version

0.0.5

License

Apache-2.0

Unpacked Size

47.5 kB

Total Files

23

Last publish

Collaborators

  • rajeshs32
  • agishan.lingasothy
  • vmishra2305
  • deepak_mohan
  • gshankar-in
  • pradeep_nayak
  • yarramanohar
  • somsekhardash
  • sabarni-condenast
  • dev-anand-94
  • anubalakrishnan
  • naveen1601
  • ganavi_j
  • sheetalparsa
  • vishnusimvisfear
  • vgoel
  • zeeshan-wani
  • vinayashreeram
  • mitchellstewart
  • nhrqz
  • ronjr_owlbear
  • snehak
  • raveena-ram
  • ankitkumar02
  • swati_verso
  • noman-cn
  • saahithisri
  • prasil1107
  • aditijhacn
  • imran-conde
  • saniyashk
  • mithunsathyanmits
  • sanjana_s
  • jyoti_3009
  • rajashreearvikar19
  • mala-shanbhag
  • ac432
  • ssingh417
  • nvillato
  • ricardofbarros
  • vmehrotr
  • speluri
  • jakir-coder
  • pranjal_sharma306500
  • tdscondenast
  • omsun22
  • midhunmurali001
  • saicharan7766
  • surabhidesai
  • suhitrathi-condenast
  • dkorenblyum
  • bbui
  • tejasvi-bg
  • vnallasa
  • vikas-sc
  • skumar7
  • cyrilpanicker-condenast
  • boygao1992
  • saikat_conde
  • imleodc
  • jasonmarlin
  • arunconde
  • roberlander
  • nprabhu-cn
  • juliendevlin
  • unviradiya
  • vinitha_thiagarajan
  • areadman
  • samruddhidube24
  • gapurdev
  • akshayjain10
  • utkarsh24
  • suma_k
  • piyush_das
  • cnmanju
  • cn-rahul-tiwari
  • dhanashri027
  • bharathikarunanithi
  • cn_priyanka14
  • prashant_singhparihar
  • m-mallikarjuna
  • smantriconde
  • machelslackatcondenast
  • karthik_cn
  • muthuprakashvelumani
  • issanjana
  • a-rena
  • colin-alexa
  • ramkun
  • namansingh_bhandari
  • cnarkhede
  • hebsibal_selvaraj
  • akeshavamurthy
  • priyanka_jha
  • klnarayanan
  • spoorthi.chandrashekar
  • erikveland
  • asinghconde
  • eunianina
  • raxs
  • vivekans
  • conde_jode
  • jordi.escude
  • nnasirov
  • unnatik
  • psundar
  • arhovale
  • rashmicn
  • siddhu-23
  • atp-engineering
  • danj-cn
  • maila-labib
  • anilc93
  • lavishgambhir
  • ksriniva2
  • andregcab
  • tchathur
  • kangkanbora
  • vinay-pr
  • josephrussell-cn
  • anaedzm
  • cn-connorbrannigan
  • prajwal_keshav
  • babincondenast
  • edistel
  • balar20
  • cn_jenkins
  • frandevinney
  • renovate
  • condenastadmin
  • copilot-robot
  • fennen529
  • fmadrie
  • gmedina
  • bigzed
  • biku
  • joshcondenast
  • rashmi-rao
  • imakshath
  • nishkalaadiga
  • niharanil
  • katiasfihivogue
  • alokreddycn
  • prakashn37
  • andi.anderson522
  • davidkofahl
  • tollmanz
  • amalamchtal
  • tdshap
  • sayeedcn
  • pitchfork-dev
  • danhaller
  • rajasinghcondenast
  • derrickatcn
  • tce
  • cnid_engineering
  • lilyhealey
  • prajaktak
  • manthanbhosle
  • psharma2
  • bhumikakhatri
  • igostu
  • cwoldt
  • mtzhang
  • manthanraut
  • drosenbaum
  • aswani_gupta
  • garryyao
  • yakshita
  • kalyanikasar
  • shreyapa
  • natelawscn
  • leahzxxz
  • katemont
  • eddleston
  • rtt
  • eshno
  • anwaukoni
  • eduardoveras
  • mrgentax
  • cl4m
  • spollini
  • fedeava
  • guidop91
  • nithya10
  • abigaild45
  • mb_dev
  • emilyatk
  • luis_gomez
  • karmenn
  • khiaraortiz
  • dmitriy_komarov-cn
  • jmcamacho
  • ishita_tiwari
  • hariprasath_cn
  • iamsuneeth
  • srikanthns
  • pushp-1992
  • sudiptacondenast
  • utkarsh_sanjivan-conde
  • mallica
  • shobith
  • agururajan
  • upenpanging
  • rjain198
  • ashwini_uppar
  • pmasade
  • jbergdol
  • suresharam
  • dhanraj_cn
  • pratik-gupta
  • ilankumaran
  • samtiffin
  • adityaanand534
  • chandan-condenast
  • vijayalakshmi-sunagar
  • namankumarsinha
  • sumitmaurya21
  • pashoka
  • nidhiarya-condenast
  • smita2022
  • ankushvijay93
  • likhita
  • priyankanandi
  • soumyagundu
  • cnrahulrkr
  • ramya-cn
  • dikshita_khandke
  • ambay_chaurasia
  • manikandancn
  • rghvndr99
  • mulla2