danger-php_codesniffer 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23cc009cec8cfa4a8d99e6443316d4d7268b5b9afa7da8b13e5f3778f13b3b24
-  data.tar.gz: '0974b16cd56019db58cc2357ade319c4eeee9d8b9412b47aac84f413e49d84f4'
+  metadata.gz: 94e2d149df27164dbc3c2ca8e784da9e86c694258d602ce5a8cfaa31e1fa3990
+  data.tar.gz: 3f0247e8338e89f5124259b8c4eacda562cfbe7df036c220fc485993b5dcf8a5
 SHA512:
-  metadata.gz: 3661a1f5f1e62f239213059b97317ec8943f504137ba350968094f6585b3b5fbcd0851d39d5f482d4d741aed68e2d988d8b42a7cc0802f03299aedf099a9626d
-  data.tar.gz: 2b63d19726fb70a120ce77b6cd076c264a33ec735b62024296a6eeed31a52f5a1270724ff4b6eea11043d60949d226cfa0188f82c958f13a2e576802149ca8ab
+  metadata.gz: 9270f35b3ae56dd65c532ea7db39167c629e212428c24ea218606d8b42dbd928cb945b4eb03bfb057f30bacdce12a95ec0350fd2ea57bde564690b0e2781d152
+  data.tar.gz: 862ce6904a412a0d8327385cb07cc48865e9105315712bb94d28023f0a2f0f38a7b57f2007612de013ee5c0c872d3456a62be359dfd7c51bd410b86d9ba9e0c4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-php_codesniffer (0.1.5)
+    danger-php_codesniffer (0.1.6)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -115,7 +115,7 @@ GEM
       unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.20.3)
     unicode-display_width (1.4.1)
-    yard (0.9.16)
+    yard (0.9.20)
 
 PLATFORMS
   ruby

data/README.md

@@ -14,27 +14,41 @@ $ gem install danger-php_codesniffer
 
 Detect your PHP violations of a defined coding standard. The plugin will post a comment on PR/MR on your Github or Gitlab project.
 
-Dangerfile:
+Add this to your Dangerfile to run CodeSniffer:
 
 ```
 php_codesniffer.exec
 ```
 
-Ignore file/path and use specific coding standard:
+---
+
+You can modify how the plugin behaves by adding one or more of the following options before the `php_codesniffer.exec` call:
+
+Ignore file/path:
 
 ```
 php_codesniffer.ignore = "./vendor"
+```
+
+Use specific coding standard:
+
+```
 php_codesniffer.standard = "CodeIgniter"
-php_codesniffer.exec
 ```
 
 Only check new and modified file:
 
 ```
 php_codesniffer.filtering = true
-php_codesniffer.exec
 ```
 
+Fail the pipeline if CodeSniffer reports any errors (you also have to run Danger with the `--fail-on-errors` flag set to true):
+
+```
+php_codesniffer.fail_on_error = true
+```
+
+
 ## Development
 
 1. Clone this repo

data/lib/php_codesniffer/gem_version.rb

@@ -1,3 +1,3 @@
 module PhpCodesniffer
-  VERSION = "0.1.5".freeze
+  VERSION = "0.1.6".freeze
 end

data/lib/php_codesniffer/plugin.rb

@@ -30,6 +30,12 @@ module Danger
     # @return [Boolean]
     attr_accessor :filtering
 
+    # An attribute for failing on errors
+    # In case phpcs finds errors, Danger will also fail
+    # This allows failing pipelines using the `--fail-on-errors` flag in Danger
+    # @return [Boolean]
+    attr_accessor :fail_on_error
+
     # Execute and process phpcs CLL's result.
     #
     # @return [void]
@@ -63,6 +69,9 @@ module Danger
       markdown "# PHP_CodeSniffer report"
       markdown generate_summary_markdown summary
       markdown report
+      if fail_on_error && summary["errors"] > 0
+        fail "There are #{summary["errors"]} errors that need to be resolved."
+      end
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-php_codesniffer
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - ymhuang0808
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2020-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api