{"id":21884000,"url":"https://github.com/condenast/opensource-check","last_synced_at":"2025-04-15T07:16:43.937Z","repository":{"id":48034319,"uuid":"121846241","full_name":"CondeNast/opensource-check","owner":"CondeNast","description":"Unit Tests for Open Source code \u0026 community guidelines","archived":false,"fork":false,"pushed_at":"2023-07-08T13:08:25.000Z","size":940,"stargazers_count":32,"open_issues_count":15,"forks_count":3,"subscribers_count":117,"default_branch":"master","last_synced_at":"2025-04-15T07:16:37.882Z","etag":null,"topics":["checklist","cli","javascript","jest","nodejs","opensource"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CondeNast.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-02-17T10:31:34.000Z","updated_at":"2024-05-09T08:10:32.000Z","dependencies_parsed_at":"2023-12-21T01:12:03.715Z","dependency_job_id":"c9bc617b-b703-4414-ac76-937d6c20824f","html_url":"https://github.com/CondeNast/opensource-check","commit_stats":{"total_commits":33,"total_committers":6,"mean_commits":5.5,"dds":0.4545454545454546,"last_synced_commit":"e126305b65bff72cc3c432f3594a693a38eff816"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CondeNast%2Fopensource-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CondeNast%2Fopensource-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CondeNast%2Fopensource-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CondeNast%2Fopensource-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CondeNast","download_url":"https://codeload.github.com/CondeNast/opensource-check/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249023742,"owners_count":21199961,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checklist","cli","javascript","jest","nodejs","opensource"],"created_at":"2024-11-28T10:11:02.806Z","updated_at":"2025-04-15T07:16:43.915Z","avatar_url":"https://github.com/CondeNast.png","language":"JavaScript","readme":"# OpenSource Check ✅\nA Test Runner for verifying Open Source conventions in JavaScript projects\n\n[![license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat)](LICENSE)\n\n_Proudly built by:_\n\n\u003ca href=\"https://technology.condenast.com\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/1215971/35070721-3f136cdc-fbac-11e7-81b4-e3aa5cc70a17.png\" title=\"Conde Nast Technology\" width=350/\u003e\u003c/a\u003e\n\n## Pre-Requisites\n\nThis utility can currently only be used for JavaScript/Node projects.\n\n## Install\n\nThis utility can be used as a temporary dependency, global dependency or a dev dependency.\n\nHead over to the [usage](##usage) section below on how to set it up based on your preference.\n\n## Usage\n\n### Parameters\n\nThe utility accepts the following parameters:\n\n* --path - to specify the path of your project directory (defaults to current working directory)\n* --org - to specify the npm organization namespace for your project\n\n### Usage as a temporary dependency\n\nThis is great option for taking this a quick spin!\n\n    npx @condenast/opensource-check --path \u003cyour-project-path\u003e\n    npx @condenast/opensource-check --path ./glamorous\n    npx @condenast/opensource-check --path ./xml-to-react --org condenast\n\n### Usage as a global dependency\n\nThis is a good option if you plan to use this frequently but don't want it to be a part of your project setup.\n\n    npm install -g @condenast/opensource-check\n\n    opensource-check --path \u003cyour-project-path\u003e\n    opensource-check --path ./glamorous\n    opensource-check --path ./xml-to-react --org condenast\n\n### Usage as a dev dependency\n\nThis is a wonderful option if you plan to use this as part of your project workflow including using in CI environment.\n\n    npm install -D @condenast/opensource-check\n\n    npx @condenast/opensource-check --path \u003cyour-project-path\u003e\n    npx @condenast/opensource-check --path ./glamorous\n    npx @condenast/opensource-check --path ./xml-to-react --org condenast\n\n### Screenshot\n\nThis is a sample screenshot of running this utlility:\n\n\u003cimg src=\"https://user-images.githubusercontent.com/1215971/37443485-74f4b324-27da-11e8-9e77-957de7edaec8.png\" title=\"screenshot\" width=350/\u003e\u003c/a\u003e\n\n## Checklist\n\nThe current checklist of things that are verified by the utility on every run:\n\n### Documentation\n\n- [ ] Has a README\n  - [ ] Has a Title\n  - [ ] Has an Install section\n  - [ ] Has a Usage section\n- [ ] Has a License\n- [ ] Has a Code of Conduct\n- [ ] Has Contributing Guidelines\n- [ ] Has an Issue template\n- [ ] Has a Pull Request template\n- [ ] Has a Changelog\n- [ ] Has Examples\n\n### Development\n\n- [ ] Has a package.json\n  - [ ] Has org namespace, if applicable\n  - [ ] Has a version\n  - [ ] Has a description\n  - [ ] Has a main or bin\n  - [ ] Has a link to git repository\n  - [ ] Has contributors\n  - [ ] Has a license\n- [ ] Has a .gitignore\n- [ ] Has a linter\n- [ ] Has a test runner\n\n## Boilerplate\n\nThese documents are provided under the [boilerplate](/boilerplate) directory for use by any project:\n\n1. LICENSE.md - [Apache 2.0](https://github.com/licenses/license-templates/blob/master/templates/apache.txt)\n2. CODE_OF_CONDUCT.md - [Contributor Covenant v1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.md)\n3. CONTRIBUTING.md - (inspired from [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) and [Rails](https://github.com/rails/rails/blob/master/CONTRIBUTING.md))\n4. ISSUE_TEMPLATE.md\n5. PULL_REQUEST_TEMPLATE.md\n6. README.md\n\n## Projects that Checked-Out!\n\nThis is a list of projects that pass the Open Source Checks:\n\n* OpenSource Check - how meta!\n* [XML To React](https://github.com/condenast/xml-to-react)\n* [Quick Bus](https://github.com/condenast/quick-bus)\n* [Launch Vehicle FBM](https://github.com/condenast/launch-vehicle-fbm)\n\n## Thanks\n\nWe were inspired by the ideas and code of the following projects:\n\n* [oss-checklist](https://github.com/scriptnull/oss-checklist)\n* [repolinter](https://github.com/todogroup/repolinter)\n* [danger-js](https://github.com/danger/danger-js)\n\n## Contributors\n\nSee the list of [contributors](https://github.com/CondeNast/opensource-check/contributors) who participated in writing this tool.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcondenast%2Fopensource-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcondenast%2Fopensource-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcondenast%2Fopensource-check/lists"}