erb-lint is a tool to help lint your ERB or HTML files using the included linters or by writing your own.
- Ruby 2.2.0+ (Runtime)
- Ruby 2.3.0+ (Development)
- This is due to the use of the tilde-heredoc
<<~syntax in some tests.
gem install erb_lint...or add the following to your Gemfile and run bundle install:
gem 'erb_lint'- First prepare your configurations to specify which Linters you want to use. Configuration details can be found here.
config = {
'linters' => {
'FinalNewline' => {
'enabled' => true
}
}
}- Next instantiate a Runner with the configuration.
runner = ERBLint::Runner.new(config) - Finally, we can run the Runner against a file:
<!-- file.html.erb -->
<div class="foo"></div>file = File.read('file.html.erb')
violations = runner.run(file)The runner returns a violation list containing each linter that was run and its corresponding list of errors.
violations
# => [{
# linter_name: 'FinalNewline',
# errors: [
# { line: 1, message: 'Missing a trailing newline at the end of the file.' }
# ]
# }]The general format for the configuration is:
config = {
'linters' => {
'Linter1' => {
'enabled' => true,
'linter_specific_option' => 'value',
...
},
'Linter2' => {
'enabled' => false,
'linter_specific_option' => 'value',
...
}
}
}All linters have an enabled option which can be true or false, which
controls whether the linter is run, along with linter-specific options.
erb-lint comes with 2 linters on-board: DeprecatedClasses and FinalNewline, each with their own linter-specific options.
DeprecatedClasses will find all classes used on HTML elements and report any classes that violate the rule set that you provide.
This rule_set is specified as a list of rules each with a set of deprecated classes and a corresponding suggestion.
'rule_set' => [
{
'deprecated' => ['class1', 'class2'],
'suggestion' => "Use class3 instead!"
},
{
'deprecated' => ['regular-expressions-*', 'size--\d+'],
'suggestion' => "Hey aren't regular expressions neat?"
}
]You can also specify an addendum to be added to the end of each error message using the addendum option.
The error message format is: "Deprecated class ... #{suggestion}"
or "Deprecated class ... #{suggestion} #{addendum}" if an addendum is present.
| Linter-Specific Option | Description |
|---|---|
rule_set |
A list of rules, each with a deprecated and suggestion option. |
deprecated |
A list of regular expressions which specify the classes deprecated by this rule. |
suggestion |
A string to be included in the rule's error message. Make this informative and specific to the rule that it is contained in. |
addendum |
A string to be included at the end of every error message of the rule set. (Optional) |
Files should always have a final newline. This results in better diffs when adding lines to the file, since SCM systems such as git won't think that you touched the last line.
You can customize whether or not a final newline exists with the present
option.
| Linter-Specific Option | Description |
|---|---|
present |
Whether a final newline should be present (default true) |
erb-lint allows you to create custom linters specific to your project. It will load linters from the .erb-linters directory in the root of your
repository. See the linters directory for examples of how to write
linters. Don't forget to enable the linter in the configuration!
# .erb-linters/another_linter.rb
module ERBLint
class Linter::AnotherLinter < Linter
include LinterRegistry
...
end
endconfig = {
'linters' => {
...
'AnotherLinter' => {
'enabled' => true,
'linter_specific_option' => 'value',
...
}
...
}
}- Fork this repo.
- Create a new branch.
git checkout -b new-branch-name - Add and commit your changes.
git add .git commit -m "Added these cool things." - Push to Github.
git push -u origin new-branch-name - Create a Pull Request on this repo against your branch.
Please write tests!
To run tests:
-
run
bundle installto installrspec -
bundle exec rspec specto run the test suite.
This project is released under the MIT license.