danger-hlint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd14c1da49d7c97a0f54878aa2ad2e3f9d7b7485
-  data.tar.gz: 0e03a82a957390f5cef8b47b2e31559d684cbb8d
+  metadata.gz: b14607b18e13304e833cac39f07fa838e96eb2cc
+  data.tar.gz: d4d8e7fe9b561c6640b234271c8948af131b4069
 SHA512:
-  metadata.gz: 4ba752949ec302c3244e0417fc18739231e939cce135c4a77f0041208a9134a316382435634464bcd3c1d702ac9d1ccf6ad392cd5b006e3d0131097f2b045b09
-  data.tar.gz: 4cd241884902f3faa17c8c7764fdedcbbed6998f6d734f035995856a49723c3be76e58bdb4260c80525277e65ff19fe97961cba8dcaf88d943487eda6ab74809
+  metadata.gz: c41a1ec511a1bc304a1176334dbbfe75e93acc7ac85b8c168f2ace9f93fb1115e17ea99873eb0ea2a052ffd882db6855326b78d4125041df1a7aaf4bf3ce9d0d
+  data.tar.gz: f74fbbb422f5693f13b0fed6cdda2acc484c7edfb6ae5c681f080bf38a7c3f871346e69dd7d96aded990809b549d190649bfb39980117b71fafc35785bd70370

data/README.md

@@ -2,6 +2,8 @@
 
 A Danger plugin for [HLint](https://github.com/ndmitchell/hlint)
 
+Read a full how to at [http://allocinit.io/haskell/danger-and-hlint/](http://allocinit.io/haskell/danger-and-hlint/)
+
 ## Installation
 
 Add this line to your Gemfile:
@@ -18,10 +20,18 @@ your `Dangerfile` under the `hlint` namespace.
 At the moment one single method is exposed: `hlint.lint`
 
 If you want the lint results to show in the diff instead of in the comments, you can use then `inline_mode` option.
-Violations that occur out of the diff will show in danger's fail or warn section.
+Violations that occur out of the diff will show in danger's fail or warn section. Here's a minimal example of what to add to your `Dangerfile` (read the inline comments):
 
 ```ruby
-hlint.lint files inline_mode: true
+# get all affected files by the changes in the current diff
+affected_files = git.added_files + git.modified_files
+
+# limit files to .hs files
+haskell_files = affected_files.select { |file| file.end_with?('.hs') }
+
+# run hlint on the files and comment inline in the PR
+hlint.lint haskell_files, inline_mode: true
+
 ```
 
 To pass other parameters to the linter just add them to the method call. The
@@ -39,6 +49,17 @@ To pass switches to the linter (like `--quiet`) specify `true` as the value in t
 hlint.lint files quiet: true
 ```
 
+## Warning
+
+When running `danger-hlint` on your CI server **(especially CircleCI 2.0)** make sure that the `hlint` binary is in your `PATH`, else this plugin will silently fail to produce any linting output. One possibele way to do this (in CircleCI 2.0) is:
+
+```
+      - run:
+          name: "Running HLint (via danger-hlint)"
+          command: |
+            export PATH="$HOME/.local/bin:$PATH"
+            bundle exec danger
+```
 
 ## Development
 

data/danger-hlint.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.4'
 
   # Linting code and docs
-  spec.add_development_dependency "rubocop", "~> 0.41"
+  spec.add_development_dependency "rubocop", "~> 0.49"
   spec.add_development_dependency "yard", "~> 0.8"
 
   # Makes testing easy via `bundle exec guard`

data/lib/hlint/gem_version.rb

@@ -1,3 +1,3 @@
 module Hlint
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-hlint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tommaso Piazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement