Gem Version Build Status Maintainability

Guard::SlimLint

A guard to lint your Slim.

Requirements

  • Ruby 2.5+
  • Slim-Lint 0.17.0+

Installation

Add this line to your application's Gemfile:

gem 'guard-slim_lint'

Add the default guard-slim_lint definition to your Guardfile

$ guard init slim_lint

Add options in Guardfile

guard :slim_lint, cli: '--no-color' do
  watch(%r{.+\.html.*\.slim$})
  watch(%r{(?:.+/)?\.slim-lint\.yml$}) { |m| File.dirname(m[0]) }
end

Guardfile

Please read the Guardfile DSL documentation for additional information.

Available options:

all_on_start: true                       # Check all files at Guard startup. default: true
slim_dires: ['app/views', 'anothor/views'] # Check Directories. default: 'app/views' or '.'
cli: '--reporter json --exclude-linter RuboCop' # Additional command line options to slim-lint. default: nil

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yatmsu/guard-slim-lint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Guard::SlimLint project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.