vouch
| Crates.io | vouch |
| lib.rs | vouch |
| version | 0.3.2 |
| source | src |
| created_at | 2021-02-04 22:38:49.391954 |
| updated_at | 2021-11-23 19:06:57.463101 |
| description | A multi-ecosystem package code review system. |
| homepage | |
| repository | https://github.com/vouch-dev/vouch |
| max_upload_size | |
| id | 350750 |
| size | 291,942 |
(rndhouse)
documentation
README
Vouch
🔍 A multi-ecosystem package code review system. 🔍
Introduction
Software packages are usually used without review. Who's checked the code? Typically, no one but the author. Vouch is a review system designed to solve this problem.
Vouch evaluates software dependencies using user generated micro-reviews. Even single line reviews become powerful when aggregated!
Getting Started
Setup
First, lets setup Vouch. During setup we can optionally specify a git repository URL for publishing reviews.
vouch setup https://github.com/<username>/reviews
Extensions
Extensions enable Vouch to create reviews for packages from different ecosystems. For example, the Python extension adds support for pypi.org packages. By default, Vouch includes extensions for Python and Javascript. Add an extension using the following command:
vouch extension add py
or via any GitHub repository URL:
vouch extension add https://github.com/vouch-dev/vouch-py
Official Extensions
| Name | Ecosystem | Package Registries |
|---|---|---|
| vouch-py | Python | pypi.org |
| vouch-js | Javascript | npmjs.com |
| vouch-ansible | Ansible Galaxy | galaxy.ansible.com |
Review
(Note: Vouch currently requires VSCode to create reviews.)
Vouch supports multiple ecosystems and is extendable. For now, Python and Javascript support comes built-in. Lets review the NPM Javascript package d3 at version 4.10.0:
vouch review d3 4.10.0
Peers
Subscribe to reviews created by other users using the command:
vouch peer add https://github.com/vouch-dev/example-reviews
Sync
The sync command pulls new reviews from peers and publishes user generated reviews:
vouch sync
Check
Reviews created using Vouch can be used to evaluate software project dependencies. Vouch extensions can discover ecosystem specific dependency definition files. For example, the Python extension parses Pipfile.lock files.
The check command generates an evaluation report of local project dependencies based on available reviews:
vouch check