Guard::Coffeelint

Coffeelint plugin for Guard

Installation

Add this line to your application's Gemfile:

gem 'guard-coffeelint'

And then execute:

$ bundle

Or install it yourself as:

$ gem install guard-coffeelint

Requirements

With guard-coffeelint@^0.1.2, you must have the coffeelint executable in your path. The easiest way to accomplish this is to install CoffeeLint globally prior to using guard-coffeelint: npm i -g coffeelint

If this doesn't work for you, use [email protected] or lower.

Usage

1. Create and customize your config file in the root of your project:

coffeelint --makeconfig > coffeelint.json

By default guard-coffeelint will look in the root of your project for coffeelint.json, but you can override the location with :config_file in your Guardfile.

2. Add Coffeelint to your Guardfile:

 # Lint CoffeeScript files on change
guard :coffeelint do
  watch %r{^app/assets/javascripts/.*\.coffee$}
end

Configuration options

You can pass some options in Guardfile like the following example:

guard :coffeelint, config_file: 'config/coffeelint.json', paths: %w(app/assets/javascripts) do
  # ...
end

Available Options

config_file: 'config/coffeelint.json' # Change the config file loaded
                                      #   default: 'coffeelint.json'

paths: %w(app/assets/javascripts)     # An array of paths passed to coffeelint to look for
                                      # coffeescript files.
                                      #   default: '.'

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request