No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
exe
lib
spec
.coveralls.yml
.gitignore
.hound.yml
.rspec
.rubocop.yml
.ruby-version
.travis.yml
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
Rakefile
hound-cli.gemspec

README.md

Hound CLI Gem Version Build Status Coverage Status

Ruby CLI created to get and build style rules we use in Platanus to play with linters. This tool was built to recreate locally, the same behavior we have in our forked version of Hound.

Installation

$ gem install hound-cli

Usage

Update command

This command allows you to update style rules for enabled linters.

$ hound rules update

After running this command you will get one file (with style rules) for each enabled linter in the remote .hound.yml file. Those files are understood by linters installed in your system. For example: with ruby language, a .rubocop.yml file will be created. This .rubocop.yml, is read by the rubocop gem (a ruby linter).

Example:

Having...

javascript:
  enabled: false
eslint:
  enabled: true
  config_file: style/config/.eslintrc.json
tslint:
  enabled: false
  config_file: style/config/tslint.json
ruby:
  enabled: true
  config_file: style/config/.rubocop.yml
stylelint:
  enabled: true
  config_file: style/config/.stylelintrc.json

And running...

$ hound rules update

You will get in your $HOME path the following files:

.eslintrc.json
.rubocop.yml
.stylelintrc.json

Also, you can pass a linter's name to update rules for specific languages.

For example:

Running...

$ hound rules update ruby tslint

You will get updated .rubocop.yml and tslint.json files in your $HOME path.

If you want to put the rules in the current path (your project's path) instead of $HOME you can run the command with --local option.

$ hound rules update --local
$ hound rules update ruby tslint --local

Running update with --local option will create a .hound.yml file in the current path too.

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

Credits

Thank you contributors!

Platanus

Paperclip Attributes is maintained by platanus.

License

Hound CLI is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.