开发者社区> 镜像站> NPM> @condenast/opensource-check
@condenast/opensource-check
Test Runner for Open Source Conventions
Last updated 2 years ago by gautamarora .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @condenast/opensource-check -g
SYNC missed versions from official npm registry.

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.

Current Tags

  • 0.0.4                                ...           latest (2 years ago)

9 Versions

  • 0.0.4                                ...           2 years ago
  • 0.0.3                                ...           2 years ago
  • 0.0.2                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
  • 0.0.1-5                                ...           3 years ago
  • 0.0.1-4                                ...           3 years ago
  • 0.0.1-3                                ...           3 years ago
  • 0.0.1-2                                ...           3 years ago
  • 0.0.1-1                                ...           3 years ago
Maintainers (223)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 9
Dependencies (2)
Dev Dependencies (9)
Dependents (0)
None