haml-lint is a tool to help keep your HAML files
clean and readable. You can run it manually from the command-line, or integrate
it into your SCM hooks. It uses rules
established by the team at Causes.com.
- Ruby 1.9.3+
- HAML 4.0.3+
gem install haml-lintRun haml-lint from the command-line by passing in a directory (or multiple
directories) to recursively scan:
haml-lint app/views/You can also specify a list of files explicitly:
haml-lint app/**/*.html.hamlhaml-lint will output any problems with your HAML, including the offending
filename and line number.
| Command Line Flag | Description |
|---|---|
-e/--exclude |
Exclude one or more files from being linted |
-i/--include-linter |
Specify which linters you specifically want to run |
-x/--exclude-linter |
Specify which linters you don't want to run |
-h/--help |
Show command line flag documentation |
--show-linters |
Show all registered linters |
-v/--version |
Show version |
haml-lint is an opinionated tool that helps you enforce a consistent style in
your HAML. As an opinionated tool, we've had to make calls about what we think
are the "best" style conventions, even when there are often reasonable arguments
for more than one possible style. While all of our choices have a rational
basis, we think that the opinions themselves are less important than the fact
that haml-lint provides us with an automated and low-cost means of enforcing
consistency.
Any lint can be disabled by using the --exclude-linter flag.
haml-lint integrates with Rubocop to
check the actual Ruby code in your templates. It will respect any
Rubocop-specific configuration you have set via .rubocop.yml files, but will
also explicitly ignore some checks that don't make sense in the context of HAML
(like BlockAlignment).
-# example.haml
- name = 'James Brown'
- unused_variable = 42
%p Hello #{name}!example.haml:3 [W] Useless assignment to variable - unused_variable
-
Don't write unnecessary
%divwhen it would otherwise be implicit.// Incorrect - div is unnecessary when a class/ID is specified %div.button // Correct - div is required when no class/ID is specified %div // Correct .button
-
Don't span multiple lines using the multiline pipe (
|) syntax.// Incorrect %p= 'Some' + | 'long' + | 'string' | // Correct - use helpers to generate long dynamic strings %p= generate_long_string // Correct - split long method calls on commas %p= some_helper_method(some_value, another_value, yet_another_value) // Correct - split attribute definitions/hashes on commas %p{ data: { value: value, name: name } }
The multiline bar was made awkward intentionally by the creators of HAML.
haml-linttakes this a step further by discouraging its use entirely, as it almost always suggests an unnecessarily complicated template that should have its logic extracted into a helper. -
Separate script indicators (
-/=) from their code with a single space.// Incorrect - no space between `=` and `some_value` =some_value // Correct = some_value // Correct - some_value = 'Hello World'
-
Tag names should comprise of all lowercase letters.
// Incorrect %BODY // Correct %body
We love getting feedback with or without pull requests. If you do add a new feature, please add tests so that we can avoid breaking it in the future.
Speaking of tests, we use rspec, which can be run like so:
bundle exec rspecIf you'd like to integrate haml-lint with Git as a pre-commit hook, check out
our Git hook manager, overcommit.
This project is released under the MIT license.