Project

hamlcop

0.0
No release in over a year
RuboCop runner for Haml template.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

Hamlcop

Gem Version test

RuboCop runner for Haml template.

Installation

Add this line to your application's Gemfile:

gem 'hamlcop'

And then execute:

bundle install

Or install it yourself as:

gem install hamlcop

Usage

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

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

Example

$ hamlcop "spec/fixtures/**/*.haml"
Inspecting 1 file
C

Offenses:

spec/fixtures/dummy.haml:1:13: C: [Correctable] Style/CharacterLiteral: Do not use the character literal - use string literal instead.
%div(a="b #{?c}")
            ^^
spec/fixtures/dummy.haml:2:7: C: [Correctable] Style/HashSyntax: Use the new Ruby 1.9 hash syntax.
%div{ :a => "b" }
      ^^^^^
spec/fixtures/dummy.haml:2:13: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
%div{ :a => "b" }
            ^^^

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

Configuration

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

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

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

# .hamlcop.yml
inherit_from:
  - .rubocop.yml

Foo/Bar:
  Enabled: false