README.md in goodcheck-1.4.1 vs README.md in goodcheck-1.5.0

- old
+ new

@@ -1,5 +1,7 @@ +![Goodcheck logo](logo/GoodCheck%20Horizontal.png) + # Goodcheck - Regexp based customizable linter Are you reviewing a pull request if the change contains deprecated API calls? Do you want to post a comment to ask the developer if a method call satisfies some condition to use that without causing an issue? What if a misspelling like `Github` for `GitHub` can be found automatically? @@ -172,10 +174,23 @@ - A string which represents an relative file path from config file, or - A http/https URL which represents the location of rules The rules file is a YAML file with array of rules. +## Excluding files + +`goodcheck.yml` can have optional `exclude` attribute. + +```yaml +rules: [] +exclude: + - node_modules + - vendor +``` + +Value of `exclude` can be a string or an array of strings representing the glob pattern for excluded files. + ## Commands ### `goodcheck init [options]` The `init` command generates an example of configuration file. @@ -203,11 +218,11 @@ * `-v`, `--verbose` to be verbose. * `--debug` to print all debug messages. * `--force` to ignore downloaded caches `goodcheck check` exits with: - + * `0` when it does not find any matching text fragment * `2` when it finds some matching text * `1` when it finds some error You can check its exit status to identify if the tool find some pattern or not. @@ -235,27 +250,26 @@ Downloaded rules are cached in `cache` directory in *goodcheck home directory*. The *goodcheck home directory* is `~/.goodcheck`, but you can customize the location with `GOODCHECK_HOME` environment variable. The cache expires in 3 minutes. -## Docker image +## Docker Images -You can use a docker image to use Goodcheck. +You can use [Docker images](https://hub.docker.com/r/sider/goodcheck/) to use Goodcheck. +For example: ```bash -$ git clone https://github.com/sideci/goodcheck -$ cd goodcheck -$ docker build -t goodcheck:latest . +$ docker pull sider/goodcheck $ cd /path/to/your/project -$ docker run -it --rm -v "$(pwd):/work" goodcheck:latest goodcheck check +$ docker run -it --rm -v "$(pwd):/work" sider/goodcheck goodcheck check ``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/sideci/goodcheck. +Bug reports and pull requests are welcome on [GitHub](https://github.com/sider/goodcheck).