Skip to content

tenpaiyomi/guard-kibit

Repository files navigation

Gem Version

guard-kibit

guard-kibit allows you to automatically check Clojure code style with Kibit when files are modified.

Installation

Please make sure to have Guard installed before continue.

Add guard-kibit to your Gemfile:

group :development do
  gem 'guard-kibit'
end

and then execute:

$ bundle install

or install it yourself as:

$ gem install guard-kibit

Add the default Guard::Kibit definition to your Guardfile by running:

$ guard init kibit

Usage

Please read the Guard usage documentation.

Options

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

guard :kibit, all_on_start: false do
  # ...
end

Available Options

all_on_start: true     # Check all files at Guard startup.
                       #   default: true
notification: :failed  # Display Growl notification after each run.
                       #   true    - Always notify
                       #   false   - Never notify
                       #   :failed - Notify only when failed
                       #   default: :failed

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

License

Copyright (c) 2020 Eric Musgrove

See the LICENSE.txt for details.

About

Guard::Kibit automatically runs your kibit linting

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages