Slimcop

Gem Version test

RuboCop runner for Slim template.

Installation

Add this line to your application's Gemfile:

gem 'slimcop'

And then execute:

bundle install

Or install it yourself as:

gem install slimcop

Usage

Use slimcop executable to check offenses and auto-correct them.

$ slimcop --help
Usage: slimcop [options] [file1, file2, ...]
    -a, --auto-correct               Auto-correct offenses.
    -c, --config=                    Specify configuration file.
        --[no-]color                 Force color output on or off.

Example

$ slimcop 'spec/fixtures/**/*.slim'
Inspecting 1 file
C

Offenses:

spec/fixtures/dummy.slim:1:3: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
- "a"
  ^^^
spec/fixtures/dummy.slim:3:5: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
| #{"c"}
    ^^^

1 file inspected, 2 offenses detected, 2 offenses auto-correctable

Configuration

Slimcop will start looking for the configuration file in the following locations:

  1. /path/to/project/.slimcop.yml
  2. /path/to/project/.rubocop.yml

For example, if you want to disable some cops on slimcop, you can add the following file to your project:

# .slimcop.yml
inherit_from:
  - .rubocop.yml

Foo/Bar:
  Enabled: false