https://github.com/ericqweinstein/ruumba

RuboCop linting for ERB templates.
https://github.com/ericqweinstein/ruumba

erb rubocop ruby

Last synced: about 1 month ago
JSON representation

RuboCop linting for ERB templates.

• Host: GitHub
• URL: https://github.com/ericqweinstein/ruumba
• Owner: ericqweinstein
• License: mit
• Created: 2015-04-26T17:25:28.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-08-19T10:39:49.000Z (over 3 years ago)
• Last Synced: 2024-11-17T14:04:25.557Z (about 2 months ago)
• Topics: erb, rubocop, ruby
• Language: Ruby
• Size: 102 KB
• Stars: 94
• Watchers: 7
• Forks: 10
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Ruumba

======

[![Build Status](https://travis-ci.org/ericqweinstein/ruumba.svg?branch=master)](https://travis-ci.org/ericqweinstein/ruumba)

> .erb or .rb, you're coming with me.

> — RuboCop

## About

Ruumba is [RuboCop's](https://github.com/bbatsov/rubocop) sidekick, allowing you to lint your .erb Rubies as well as your regular-type ones.

## Dependencies

* Ruby 2.4+

## Installation

```bash

λ gem install ruumba

```

## Usage

Command line:

```bash

λ ruumba directory_of_erb_files/

```

Rake task:

```ruby

require 'ruumba/rake_task'

Ruumba::RakeTask.new(:ruumba) do |t|

  t.dir = %w(lib/views)

  # You can specify CLI options too:

  t.options = { arguments: %w[-c .ruumba.yml] }

end

```

Then:

```bash

λ bundle exec rake ruumba

```

## Fix Paths and Non-Applicable Cops

By default, RuboCop only scans `.rb` files and so does Ruumba. If you want shown

paths to reflect original paths, you can add create a `.ruumba.yml` config file

with the following contents:

```yaml

AllCops:

  Include:

    - '**/*.erb'

```

You can then disable the `.rb` extension auto-append and use your config file:

```bash

λ ruumba -D -e app/views -c .ruumba.yml

```

Since Ruumba rewrites new files from `.erb` files contents, some formatting cops

cannot apply. You can disable them in your Ruumba config file:

```yaml

Style/FrozenStringLiteralComment:

  Enabled: false

Layout/HashAlignment:

  Enabled: false

Layout/ParameterAlignment:

  Enabled: false

Layout/IndentationWidth:

  Enabled: false

Layout/TrailingEmptyLines:

  Enabled: false

```

You can use `ruumba -a` or `ruumba -D` to look for other cops if this list is

missing some.

You might want to include your existing RuboCop config file by appending this in

front of your Ruumba config:

```yaml

inherit_from: .rubocop.yml

```

### Editor Integrations

* [Atom plugin](https://atom.io/packages/linter-ruumba)

* [Vim plugin](https://github.com/dense-analysis/ale)

* [Emacs package](https://github.com/flycheck/flycheck)

## Contributing

1. Branch (`git checkout -b fancy-new-feature`)

2. Commit (`git commit -m "Fanciness!"`)

3. Test (`bundle exec rake spec`)

4. Lint (`bundle exec rake rubocop`)

5. Push (`git push origin fancy-new-feature`)

6. Ye Olde Pulle Requeste