@condenast/opensource-check
Advanced tools
A Test Runner for verifying Open Source conventions in JavaScript projects
Proudly built by:
This utility can currently only be used for JavaScript/Node projects.
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.
The utility accepts the following parameters:
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
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
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
This is a sample screenshot of running this utlility:
The current checklist of things that are verified by the utility on every run:
These documents are provided under the boilerplate directory for use by any project:
This is a list of projects that pass the Open Source Checks:
We were inspired by the ideas and code of the following projects:
See the list of contributors who participated in writing this tool.
0.0.5 - 2021-05-24
FAQs
Test Runner for Open Source Conventions
We found that @condenast/opensource-check demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 357 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket researchers discovered nine malicious NuGet packages that use time-delayed payloads to crash applications and corrupt industrial control systems.
Security News
Socket CTO Ahmad Nassri discusses why supply chain attacks now target developer machines and what AI means for the future of enterprise security.
Security News
Learn the essential steps every developer should take to stay secure on npm and reduce exposure to supply chain attacks.