Bento is a free command-line tool that finds the bugs that matter to you
Project description
Bento
Bento finds the bugs that matter to you.
Bento automatically tailors linters and static analysis with sane defaults on a per-project basis, letting you focus on writing code rather than configuring tools. Bento is free, fully-featured, and you can run Bento on as many projects as you like.
Installation
Requirements
Bento is supported on macOS Mojave (10.14) and Ubuntu 18.04+, and requires Python version 3.6 or later and pip3.
Bento supports npm-packaged JavaScript and Python, and is ideal for monorepos.
Installing Bento
Run
pip3 install bento-cli
Usage
The workflow for Bento is:
- Initialize Bento
- Run Bento checks on your source code
- Fix issues or archive unnecessary warning and errors
- Disable undesired checks
- Add Bento to git pre-commit hooks
- Add Bento to the CI pipeline (e.g., CircleCI)
Initialize Bento for a project:
To set up for a project, navigate to the root of your project (e.g., where your .git directory is located).
Then run:
bento init
This will install and configure Bento for your project.
For git
Add this to your .gitignore:
.bento
Analyze your source code
To trigger Bento to analyze your project, run:
bento check
Archive outstanding issues
The archive command whitelists outstanding issues to fix later. This lets you continue coding with a clean slate without having to address all your tech debt as soon as you adopt a new tool. New issues introduced from this point forward will be reported by Bento until the next time you run the archive command.
bento archive
and commit the resulting .bento-baseline.yml file.
Disable and enable individual checks
Enable/disable a specific check by running:
bento enable [OPTIONS] TOOL CHECK
or
bento disable [OPTIONS] TOOL CHECK
where:
TOOLrefers to the tool that includes the check, for example,r2c.eslintCHECKrefers to the label for the check you want to enable, for exampleno-console
Example:
bento enable r2c.eslint no-console
You can find the tool and check names in the output of bento check. Bento currently supports the following tools:
| Language | Supported Tools |
|---|---|
| Python | Bandit, Flake8 |
| JavaScript | ESLint |
If there are tools you'd like us to add, please let us know by creating an issue on GitHub.
Install Bento as a pre-commit hook
Bento can install itself as a pre-commit hook, so it runs before each commit and blocks on failures.
To install bento as a pre-commit hook, simply run:
bento install-hook
Demo
Here’s a short preview of Bento in action:
Community
Join the Bento channel in our community Slack to receive and give support, talk with other users, and share things about Bento. The r2c team is there and ready to help!
Terms of service and privacy
Please refer to the terms and privacy document.
License
Copyright (c) r2c.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bento-cli-0.1.0.tar.gz.
File metadata
- Download URL: bento-cli-0.1.0.tar.gz
- Upload date:
- Size: 29.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 66cc53c93ed7facc55e79ddc703ef9f378a0ccdcc3534b0af7ae28417e57fe40 |
|
| MD5 | a7a1906dbce704411fe33139d5b57b44 |
|
| BLAKE2b-256 | 9831109f01c9b22e09f1d4ac56646167f144ab3d3a6003519a6e4da19faf6c65 |
File details
Details for the file bento_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: bento_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 35.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 263c29611febe5a1c49e2e60f864d3ca49768cbf56d99e6fa8f19d2529f73046 |
|
| MD5 | 94ed725449e6e95da942f0dca7dc46ec |
|
| BLAKE2b-256 | 34e4a3840d93a9329e944125211e0d98b1f6065b99e6eb736248b1033b8ef658 |
