guard-cookstyle 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aa7c641c016b0f1678e8a9cb3e2c71894629d52
-  data.tar.gz: 241418cd7783dbff5556abe1112fca1cfaaf9535
+  metadata.gz: 5f12320c9b5e0c4747e14b1a13d274e0345e5b45
+  data.tar.gz: '03394b2dd0bb869b209e14ae38431067d958993a'
 SHA512:
-  metadata.gz: 50d6c01f906309a8a4f36d64c986cd9957be4c4a48c4eff4275505100fe93b138894ef389f2f05e6c00945078a86b45e8c5de18e9362552545ca916d2739f6d5
-  data.tar.gz: d3df5e6de2cf75e3ceb56055339f6b311934e394295f9d473e819fd870918527f226348e662fd0ca3db5558a4f4527ee2124fea47de1d5af9fa09f797b90a4f3
+  metadata.gz: 7319497e4cd71e9ad87e9ca6d2fd39057ef2e9d7cde6b43a737b4d3744292e23bbb44c5a5539a371223be371bcf24105a5632b6ce3b9046ccb64c3d7aa127bd0
+  data.tar.gz: e6211d1f4086e55ea3ffc0acc9a2bdbc0ffc7a2a9f4a2fc21171a5b50217ad7d1f0a88ac85cb1ddfb0cc3b0a0ff065320b66ef4de4db624fec4e00eb6e9030c6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.2.0
+
+I noticed there was https://github.com/chef/cookstyle#guard-rubocop, so I adjusted usage.
+
 ## 0.1.0
 
 - release

data/README.md

@@ -1,8 +1,8 @@
 # Guard::Cookstyle
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/guard/cookstyle`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/guard-cookstyle.svg)](https://badge.fury.io/rb/guard-cookstyle)
 
-guard-rubocop allows you to automatically check Chef cookbook style with [Cookstyle](https://github.com/chef/cookstyle) when files are modified.
+guard-cookstyle allows you to automatically check Chef cookbook style with [Cookstyle](https://github.com/chef/cookstyle) when files are modified.
 
 Cookstyle is a wrapper of rubocop, so most of the codes were based on [yujinakayama/guard-rubocop]((https://github.com/yujinakayama/guard-rubocop)).
 
@@ -32,8 +32,6 @@ Add the default Guard::Cookstyle definition to your Guardfile by running:
 $ guard init cookstyle
 ```
 
-Rules of Rubocop definition are loaded from `.cookstyle.yml` by default.
-
 ## Usage
 
 Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
@@ -43,7 +41,7 @@ Please read the [Guard usage documentation](https://github.com/guard/guard#readm
 You can pass some options in `Guardfile` like the following example:
 
 ```ruby
-guard :cookstyle, all_on_start: false, cli: ['--format', 'clang'], cookbook_dirs: ['mycookbooks'], rubocop_config: '.rubocop.yml' do
+guard :cookstyle, all_on_start: false, cli: ['--format', 'clang'], cookbook_dirs: ['mycookbooks'] do
   # ...
 end
 ```
@@ -69,20 +67,6 @@ launchy: nil           # Filename to launch using Launchy after RuboCop runs.
                        #   default: nil
 cookbook_dirs: []      # Directory of Cookbooks to check.
                        #   default: %w[cookbooks site-cookbooks]
-rubocop_config:        # Rubocop Config path.
-                       #   default: '.cookstyle.yml'
-```
-
-### Tips
-
-In order to use it with Rubocop, we recommend that `.cookstyle.yml` inherits `.rubocop.yml` and add cookbook specific rules.
-
-```
----
-inherit_from: .rubocop.yml
-
-... rules for cookbooks
-
 ```
 
 ## Contributing

data/guard-cookstyle.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'guard'
+  spec.add_runtime_dependency 'cookstyle'
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/guard/cookstyle.rb

@@ -18,8 +18,7 @@ module Guard
         notification: :failed,
         cli: nil,
         hide_stdout: false,
-        cookbook_dirs: %w[cookbooks site-cookbooks],
-        rubocop_config: '.cookstyle.yml',
+        cookbook_dirs: %w[cookbooks site-cookbooks]
       }.merge(options)
 
       @failed_paths = []

data/lib/guard/cookstyle/runner.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'cookstyle'
 
 module Guard
   class Cookstyle
@@ -32,7 +33,7 @@ module Guard
           command.concat(%w[--format progress]) # Keep default formatter for console.
         end
 
-        command.concat(['--config', @options[:rubocop_config]])
+        command.concat(['--config', ::Cookstyle.config])
         command.concat(['--format', 'json', '--out', json_file_path])
         command << '--force-exclusion'
         command.concat(args_specified_by_user)

data/lib/guard/cookstyle/templates/Guardfile

@@ -1,6 +1,7 @@
+require "cookstyle"
 group :cookbooks do
   guard :cookstyle do
     watch(/(cookbooks|site-cookbooks).+\.rb$/)
-    watch(%r{(?:.+/)?\.cookstyle(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
   end
 end

data/lib/guard/cookstyle/version.rb

@@ -1,5 +1,5 @@
 module GuardCookstyleVersion
   def self.to_s
-    '0.1.0'
+    '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-cookstyle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - sawanoboly
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cookstyle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement