danger-eslint 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1180844b62ed462c63d0d4499d2a966323935fe9
-  data.tar.gz: d4d0cf2f19d4253c10155f37b0c45c33bc295745
+SHA256:
+  metadata.gz: 7b174e445e2586809cf44b96f20a0c55fbe6d4d6dc5887553d30ebba6f3d14bc
+  data.tar.gz: 51517c0a75f62ef6be5d7f9a66acbb67f35d2f4b0efa0ce2e805496698b28913
 SHA512:
-  metadata.gz: b9da0dacc407c6399097ca0dbb508ac212f69367436d88ec0a9fb2eb4135188d497b4d81d9eb7d01517efa82cb482e2f684ca47fe60c29a34473ee48ba85e890
-  data.tar.gz: a81811c2be884c329c940361d322ca2dd57176f12ac20348e00d0ad1c689b7a66d419d2201d24d6cd31f3bf3da2d48cb3d25a95568a8f32caa91d1d0f53bfab7
+  metadata.gz: fb4a49df669c282bfdd9ab607afaac76c0f20de269f5e5396387159cd810f2e2843d734040befedca96bfccc01fe6c046241f7e19f4e47ec78f25bcf9c21e54f
+  data.tar.gz: 11c863060b754b577ef60add645427eb7ed21eb6b6de55093e786ea99448231c7165ca509ddabf4d8d0b826abb3c96f8ef4633463278c25c15b27db554657848

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - "**/*_spec.rb"
+  
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 25

data/.travis.yml

@@ -4,9 +4,8 @@ cache:
     - bundle
 
 rvm:
-  - 2.0
   - 2.1.3
   - 2.3.1
 
 script:
-    - bundle exec rake spec
+    - bundle exec rake spec

data/Gemfile.lock

@@ -1,49 +1,55 @@
 PATH
   remote: .
   specs:
-    danger-eslint (0.1.0)
+    danger-eslint (0.1.6)
       danger-plugin-api (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
-    ast (2.3.0)
-    claide (1.0.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    claide (1.0.3)
     claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
-    coderay (1.1.1)
+    coderay (1.1.2)
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (5.3.0)
+    danger (8.2.3)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0.9)
-      faraday-http-cache (~> 1.0)
-      git (~> 1)
-      kramdown (~> 1.5)
-      octokit (~> 4.2)
-      terminal-table (~> 1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.3)
-    faraday (0.12.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.1)
-      faraday (~> 0.8)
-    ffi (1.9.18)
+      ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-net_http (1.0.1)
+    ffi (1.9.25)
     formatador (0.2.5)
-    git (1.3.0)
-    guard (2.14.1)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    guard (2.14.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
@@ -54,67 +60,74 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    kramdown (1.13.2)
+    jaro_winkler (1.5.1)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
-    lumberjack (1.0.12)
-    method_source (0.8.2)
-    multipart-post (2.0.0)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    multipart-post (2.1.1)
     nap (1.1.0)
     nenv (0.3.0)
+    no_proxy_fix (0.1.2)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.7.0)
+    octokit (4.20.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.11.2)
-    parser (2.4.0.0)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    pry (0.10.4)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    public_suffix (2.0.5)
-    rainbow (2.2.2)
-      rake
+      method_source (~> 0.9.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (10.5.0)
-    rb-fsevent (0.9.8)
-    rb-inotify (0.9.8)
-      ffi (>= 0.5.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rchardet (1.8.0)
+    rexml (3.2.4)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rubocop (0.49.1)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
+      parser (>= 2.5)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+    ruby-progressbar (1.9.0)
+    ruby2_keywords (0.0.4)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     shellany (0.0.1)
-    slop (3.6.0)
-    terminal-table (1.8.0)
+    terminal-table (3.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (0.19.4)
-    unicode-display_width (1.2.1)
-    yard (0.9.9)
+    thor (0.20.0)
+    unicode-display_width (1.4.0)
+    yard (0.9.14)
 
 PLATFORMS
   ruby
@@ -128,8 +141,8 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.4)
-  rubocop (~> 0.41)
-  yard (~> 0.8)
+  rubocop (~> 0.49)
+  yard (~> 0.9.11)
 
 BUNDLED WITH
-   1.15.0
+   1.17.2

data/README.md

@@ -1,15 +1,46 @@
+[![Gem](https://img.shields.io/gem/v/danger-eslint.svg)](https://rubygems.org/gems/danger-eslint)
+[![Gem](https://img.shields.io/gem/dt/danger-eslint.svg)](https://rubygems.org/gems/danger-eslint)
+[![Gem](https://img.shields.io/gem/dtv/danger-eslint.svg)](https://rubygems.org/gems/danger-eslint)
+[![Travis branch](https://img.shields.io/travis/leonhartX/danger-eslint/master.svg)](https://travis-ci.org/leonhartX/danger-eslint)
 # danger-eslint
 
-A description of danger-eslint.
+A [Danger](https://github.com/danger/danger) plugin for [eslint](http://eslint.org/).
 
 ## Installation
 
     $ gem install danger-eslint
+    
+`eslint` also needs to be installed(global or local) before you run Danger, Please check the [installation guide](http://eslint.org/docs/user-guide/getting-started)
+`danger-eslint` will first try local `node_module/.bin/eslint` then the global `eslint`.
 
 ## Usage
+Run lint without and configuration will do the samething as run `eslint .`  
+All lint result will send as individual comment. If your are using Github, the comment will show as a inline comment directly on the violation's position if possiable.
+
+    eslint.lint
+
+Also, you can pass a config file or eslintignore file to danger-eslint with:
+
+    eslint.config_file = /path/yourconfig
+    eslint.ignore_file = /path/yourigonre
+    eslint.lint
+    
+If you want to lint only new/modified files. You can achieve that with setting the `filtering` parameter to `true`.
+
+    eslint.filtering = true
+    eslint.lint
+
+If you want to lint files with specified extension, you can set extensions to the `target_extensions` parameter.  
+The default value is `['.js']`. In the case of the example below, the value will be `['.js', '.es6']`.
+
+    eslint.target_extensions += %W(.es6)
+    eslint.lint
+
+If you want to specify eslint's bin file, you can set a bin path to the `bin_path` parameter.
+
+    eslint.bin_path = "/hoge/node_modules/.bin/eslint"
+    eslint.lint
 
-    Methods and attributes from this plugin are available in
-    your `Dangerfile` under the `eslint` namespace.
 
 ## Development
 

data/danger-eslint.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Eslint::VERSION
   spec.authors       = ['leonhartX']
   spec.email         = ['leonhartx.k@gmail.com']
-  spec.description   = %q{A short description of danger-eslint.}
-  spec.summary       = %q{A longer description of danger-eslint.}
+  spec.description   = %q{A Danger plugin for linting javascript with eslint.}
+  spec.summary       = %q{A Danger plugin for linting javascript with eslint.}
   spec.homepage      = 'https://github.com/leonhartX/danger-eslint'
   spec.license       = 'MIT'
 
@@ -28,8 +28,8 @@ 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 "yard", "~> 0.8"
+  spec.add_development_dependency "rubocop", "~> 0.49"
+  spec.add_development_dependency "yard", "~> 0.9.11"
 
   # Makes testing easy via `bundle exec guard`
   spec.add_development_dependency 'guard', '~> 2.14'

data/lib/eslint/gem_version.rb

@@ -1,3 +1,3 @@
 module Eslint
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/lib/eslint/plugin.rb

@@ -2,24 +2,19 @@ require 'mkmf'
 require 'json'
 
 module Danger
-  # This is your plugin class. Any attributes or methods you expose here will
-  # be available from within your Dangerfile.
+  # Lint javascript files using [eslint](http://eslint.org/).
+  # Results are send as inline commen.
   #
-  # To be published on the Danger plugins site, you will need to have
-  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
-  # for generating documentation from your plugin source, and you can verify
-  # by running `danger plugins lint` or `bundle exec rake spec`.
+  # @example Run eslint with changed files only
   #
-  # You should replace these comments with a public description of your library.
-  #
-  # @example Ensure people are well warned about merging on Mondays
-  #
-  #          my_plugin.warn_on_mondays
+  #          eslint.filtering = true
+  #          eslint.lint
   #
   # @see  leonhartX/danger-eslint
-  # @tags monday, weekends, time, rattata
-  #
+  # @tags lint, javaxctipt
   class DangerEslint < Plugin
+    DEFAULT_BIN_PATH = './node_modules/.bin/eslint'
+
     # An path to eslint's config file
     # @return [String]
     attr_accessor :config_file
@@ -33,6 +28,20 @@ module Danger
     # @return [Boolean]
     attr_accessor :filtering
 
+    # A path of eslint's bin
+    attr_writer :bin_path
+    def bin_path
+      @bin_path ||= DEFAULT_BIN_PATH
+    end
+
+    # Specified extentions of target file
+    # Default is [".js"]
+    # @return [Array]
+    attr_writer :target_extensions
+    def target_extensions
+      @target_extensions ||= %W(.js)
+    end
+
     # Lints javascript files.
     # Generates `errors` and `warnings` due to eslint's config.
     # Will try to send inline comment if supported(Github)
@@ -40,18 +49,8 @@ module Danger
     # @return  [void]
     #
     def lint
-      bin = eslint_path
-      raise 'eslint is not installed' unless bin
-      if filtering
-        results = ((git.modified_files - git.deleted_files) + git.added_files)
-                  .select { |f| f.end_with? '.js' }
-                  .map { |f| f.gsub("#{Dir.pwd}/", '') }
-                  .map { |f| run_lint(bin, f).first }
-      else
-        results = run_lint(bin, '.')
-      end
-      results
-        .reject { |r| r['messages'].length.zero? }
+      lint_results
+        .reject { |r| r.nil? || r['messages'].length.zero? }
         .reject { |r| r['messages'].first['message'].include? 'matching ignore pattern' }
         .map { |r| send_comment r }
     end
@@ -62,8 +61,20 @@ module Danger
     #
     # return [String]
     def eslint_path
-      local = './node_modules/.bin/eslint'
-      File.exist?(local) ? local : find_executable('eslint')
+      File.exist?(bin_path) ? bin_path : find_executable('eslint')
+    end
+
+    # Get lint result regards the filtering option
+    #
+    # return [Hash]
+    def lint_results
+      bin = eslint_path
+      raise 'eslint is not installed' unless bin
+      return run_lint(bin, '.') unless filtering
+      ((git.modified_files - git.deleted_files - git.renamed_files.map { |r| r[:before] }) + git.added_files + git.renamed_files.map { |r| r[:after] })
+        .select { |f| target_extensions.include?(File.extname(f)) }
+        .map { |f| f.gsub("#{Dir.pwd}/", '') }
+        .map { |f| run_lint(bin, f).first }
     end
 
     # Run eslint aginst a single file.

data/spec/eslint_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 
 module Danger
   describe Danger::DangerEslint do
@@ -16,7 +16,7 @@ module Danger
         allow(@eslint.git).to receive(:deleted_files).and_return([])
         allow(@eslint.git).to receive(:added_files).and_return([])
         allow(@eslint.git).to receive(:modified_files).and_return([])
-        allow(@eslint).to receive(:eslint_path).and_return('eslint')
+        stub_const("Danger::DangerEslint::DEFAULT_BIN_PATH", 'spec/fixtures/bin/dummy_eslint')
       end
 
       it 'does not make an empty message' do
@@ -81,6 +81,27 @@ module Danger
           expect(@eslint.status_report[:warnings].length).to be(0)
         end
 
+        it 'lint files with specified extention by target_extensions' do
+          allow(@eslint).to receive(:run_lint)
+            .with(anything, /error.[js|es6]/).and_return(@error_result)
+          allow(@eslint.git).to receive(:modified_files)
+            .and_return([
+              'spec/fixtures/javascript/error.es6',
+              'spec/fixtures/javascript/error.js'
+            ])
+
+          @eslint.target_extensions += %W(.es6)
+          @eslint.filtering = true
+          @eslint.lint
+
+          errors = @eslint.status_report[:errors]
+          expect(errors.length).to be(2)
+          errors.each do |error|
+            expect(error).to eq('Parsing error: Unexpected token ;')
+          end
+          expect(@eslint.status_report[:warnings].length).to be(0)
+        end
+
         it 'do not print anything if no violations' do
           allow(@eslint.git).to receive(:modified_files)
             .and_return(['spec/fixtures/javascript/empty.js'])
@@ -132,6 +153,21 @@ module Danger
           expect(@eslint.status_report[:errors].length).to be(1)
           expect(@eslint.status_report[:warnings].length).to be(2)
         end
+
+        it 'can specify eslint bin file' do
+          bin_file = 'spec/fixtures/bin/somewhere_eslint'
+          expect(@eslint).to receive(:run_lint)
+            .with(bin_file, /error.js/).and_return(@error_result)
+          allow(@eslint.git).to receive(:modified_files)
+            .and_return(['spec/fixtures/javascript/error.js'])
+
+          @eslint.bin_path = bin_file
+          @eslint.filtering = true
+          @eslint.lint
+          error = @eslint.status_report[:errors].first
+          expect(error).to eq('Parsing error: Unexpected token ;')
+          expect(@eslint.status_report[:warnings].length).to be(0)
+        end
       end
     end
   end

data/spec/fixtures/javascript/error.es6

@@ -0,0 +1 @@
+var a = ;

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'pathname'
-ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+ROOT = Pathname.new(File.expand_path('..', __dir__))
 $LOAD_PATH.unshift((ROOT + 'lib').to_s)
 $LOAD_PATH.unshift((ROOT + 'spec').to_s)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-eslint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - leonhartX
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -72,28 +72,28 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A short description of danger-eslint.
+description: A Danger plugin for linting javascript with eslint.
 email:
 - leonhartx.k@gmail.com
 executables: []
@@ -160,6 +160,7 @@ files:
 - ".eslintignore"
 - ".eslintrc.json"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -173,9 +174,12 @@ files:
 - lib/eslint/gem_version.rb
 - lib/eslint/plugin.rb
 - spec/eslint_spec.rb
+- spec/fixtures/bin/dummy_eslint
+- spec/fixtures/bin/somewhere_eslint
 - spec/fixtures/config/.eslintignore
 - spec/fixtures/config/.eslintrc.json
 - spec/fixtures/javascript/empty.js
+- spec/fixtures/javascript/error.es6
 - spec/fixtures/javascript/error.js
 - spec/fixtures/javascript/ignored.js
 - spec/fixtures/javascript/warning.js
@@ -205,16 +209,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A longer description of danger-eslint.
+summary: A Danger plugin for linting javascript with eslint.
 test_files:
 - spec/eslint_spec.rb
+- spec/fixtures/bin/dummy_eslint
+- spec/fixtures/bin/somewhere_eslint
 - spec/fixtures/config/.eslintignore
 - spec/fixtures/config/.eslintrc.json
 - spec/fixtures/javascript/empty.js
+- spec/fixtures/javascript/error.es6
 - spec/fixtures/javascript/error.js
 - spec/fixtures/javascript/ignored.js
 - spec/fixtures/javascript/warning.js