danger-swiftformat 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 129504b9697fb37eb0dc46c0f2f2852667119e7f
-  data.tar.gz: bc8d5744ddb99d28de270ebfee1244b58e9dcd44
+  metadata.gz: a6ee9731972b91a28abe4fc4b8c560508db30f76
+  data.tar.gz: 2f85cde2168bc1073d85e826a7b6645f43db271e
 SHA512:
-  metadata.gz: eab4ef630332a2551cb8d75b61a9d60bb57b5e8d1f9d93e7f68d32841b9581aacfa93072cf672c9f35d3e0ed6782ca9ab9d90bfc732cff364d0eead0d76603b3
-  data.tar.gz: 79038b5585e8150badcc6a4f46e1b758cbb4217e61e5de0308650c97d2d78a6d2cb9a451f913b58ae1ffb1e22dd17c622cc0e2653edb0ae64da57cb1adeba66c
+  metadata.gz: 3b1d0ff41b673f6c0cf6d0b97d17a70fb9721f858ab9d97f29a68af42e9e2089f37ee5dff6fe11edc80becd1c2222747146045040fc53b1777f55c0aeab91244
+  data.tar.gz: 5569c70f0570483713ee28a074cc07bf9027c04a29383651091a8fa8eab442c2bd42d466845411000e2af9021cc3137a80f6aee1fa2eb1efe28e4d3b9b58d6a1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-swiftformat (0.0.1)
+    danger-swiftformat (0.0.2)
       danger-plugin-api (~> 1.0)
 
 GEM

data/README.md

@@ -1,26 +1,39 @@
-# danger-swiftformat [![Build Status](https://travis-ci.org/garriguv/danger-ruby-swiftformat.svg?branch=master)](https://travis-ci.org/garriguv/danger-ruby-swiftformat)
+# danger-swiftformat [![Build Status](https://travis-ci.org/garriguv/danger-ruby-swiftformat.svg?branch=master)](https://travis-ci.org/garriguv/danger-ruby-swiftformat) [![Gem Version](https://badge.fury.io/rb/danger-swiftformat.svg)](https://rubygems.org/gems/danger-swiftformat)
 
-A [danger] plugin to check Swift formatting using [SwiftFormat].
+A [Danger] plugin to check Swift formatting using [SwiftFormat].
 
 This plugin is heavily inspired by [danger-swiftlint].
 
 ## Installation
 
-    $ gem install danger-swiftformat
+Add this line to your Gemfile:
+
+    require 'danger-swiftformat'
+
+[SwiftFormat] also needs to be installed before you run Danger.
 
 ## Usage
 
-Add the following to your `Gemfile`
+Add this to your `Dangerfile`
 
-    require 'danger-swiftformat'
+```ruby
+swiftformat.check_format
+```
 
-In your `Dangerfile`
+By default, danger-swiftformat will check added and modified files.
+
+If you want errors to fail Danger, you can use the `fail_on_error` option:
 
 ```ruby
-swiftformat.binary_path = "/path/to/swiftformat" # optional, but recommended ;)
 swiftformat.check_format(fail_on_error: true)
 ```
 
+You can specify the `swiftformat` binary using the `binary_path` parameter:
+
+```ruby
+swiftformat.binary_path = "/path/to/swiftformat"
+```
+
 ## Development
 
 1. Clone this repo
@@ -29,6 +42,6 @@ swiftformat.check_format(fail_on_error: true)
 4. Use `bundle exec guard` to automatically have tests run as you make changes.
 5. Make your changes.
 
-[danger]: https://danger.systems/ruby/
+[Danger]: https://danger.systems/ruby/
 [SwiftFormat]: https://github.com/nicklockwood/SwiftFormat
 [danger-swiftlint]: https://github.com/ashfurrow/danger-ruby-swiftlint

data/lib/swiftformat/gem_version.rb

@@ -1,3 +1,3 @@
 module Swiftformat
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

data/lib/swiftformat/plugin.rb

@@ -64,7 +64,7 @@ module Danger
     #
     # @return [SwiftFormat]
     def swiftformat
-      @swiftformat ||= SwiftFormat.new(binary_path)
+      SwiftFormat.new(binary_path)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-swiftformat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vincent Garrigues