Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nebulab/umarell
All in one Ruby static code analyzer
https://github.com/nebulab/umarell
linter rails ruby security static-analysis
Last synced: about 1 month ago
JSON representation
All in one Ruby static code analyzer
- Host: GitHub
- URL: https://github.com/nebulab/umarell
- Owner: nebulab
- License: mit
- Created: 2019-12-06T09:40:55.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-17T08:53:49.000Z (over 3 years ago)
- Last Synced: 2024-01-19T09:20:16.635Z (12 months ago)
- Topics: linter, rails, ruby, security, static-analysis
- Language: Ruby
- Homepage: https://nebulab.it
- Size: 167 KB
- Stars: 18
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Umarell
Umarell is an all in one Ruby static code analyzer.
Umarell gives you (*unwanted?*) advice on your code just like an [italian old man watching a construction site](https://en.wikipedia.org/wiki/Umarell).
## Installation
```sh
$ gem install umarell
```
## Usage
Run `umarell` in a Ruby application's root directory
```sh
$ cd ruby-application
$ umarell
```
Run `umarell` with a target directory or file
```sh
$ umarell /path/to/ruby-application
```
### Options
```sh
$ umarell -h
usage: umarell [options] [target]
-a, --autofix Autofix violations (if supported)
-m, --modified Run on modified files
-v, --version Show version
```
## Requirements
* MRI 2.3+
## Tools included
Umarell runs the following tools:
- [bundler-audit](https://github.com/rubysec/bundler-audit)
- [brakeman](https://github.com/presidentbeef/brakeman)
- [rubocop](https://github.com/rubocop-hq/rubocop)
- [erb-lint](https://github.com/Shopify/erb-lint)
- [reek](https://github.com/troessner/reek)
- [rails_best_practices](https://github.com/flyerhzm/rails_best_practices)
- [fasterer](https://github.com/DamirSvrtan/fasterer)
## License
Copyright © 2019 [Nebulab](https://nebulab.it/).
It is free software, and may be redistributed under the terms specified in the [license](LICENSE.txt).
## About
Umarell is funded and maintained by the [Nebulab](http://nebulab.it/) team.
We firmly believe in the power of open-source. [Contact us](https://nebulab.it/contact-us/) if you like our work and you need help with your project design or development.