An open API service indexing awesome lists of open source software.

https://github.com/filippoliverani/umarell

All in one Ruby static code analyzer
https://github.com/filippoliverani/umarell

formatter linter ruby ruby-on-rails static-code-analyzer

Last synced: 2 months ago
JSON representation

All in one Ruby static code analyzer

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).

![Umarell](https://raw.githubusercontent.com/nebulab/umarell/master/assets/umarell.jpg?raw=true "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 3.0+

## 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)
- [fasterer](https://github.com/DamirSvrtan/fasterer)