roger_eslint 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 147aa12ad5cdcde7af013082566d33aa3e497597
-  data.tar.gz: dc97130bb05546b487d4bedd3459703cb27eff37
+  metadata.gz: c8e887ef2a6fc0f33e0402f5a8dd6019bd2423c3
+  data.tar.gz: c553c89bc35b5eda0000d2ad550c5b0fd3d6a249
 SHA512:
-  metadata.gz: 0dce1b94ecbfed10fedccf4c96b0fb7bcb70837e03dae9dd9a4bfa11d4a736eda58b8ce37cc62c2d5ee3253feb5a2d8f5964a5744fd1b7ee578e87c2e5184d08
-  data.tar.gz: 74970d9a1f0fb43916e8eba4d06ec9ec6764d46598c137c047c3c37e36854fd7315f9eabadd210a21216010c2d6ad9a96f7eb5983f5167ec0552cb2da6eca04b
+  metadata.gz: 7e0b0a41bec1718f8ce7e1be4a9cf08984b07c21352084fd085595cd89f1c2da3b7556d1b24af52dd6c031ef800a29e2958de8db0de2087d523984368c5e85f8
+  data.tar.gz: d6e0c8788b0a9731dc45629fed1fde498db61893f4f7c203dccac4d7ff49224c8883ff2357bfec40ed4e8d8a0e0f7ae594620b8b298592700b1f8acaa46aef2f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 1.2.0
+* Make eslinting much faster
+* Readme fixes
+
 ## Version 1.0.1
 * Prefer to load eslint from local node_modules. This makes it much easier to in combination with eslint configs from other NPM.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roger_eslint (1.0.0)
+    roger_eslint (1.0.1)
       roger (~> 1.5, >= 1.0.0)
 
 GEM
@@ -10,18 +10,18 @@ GEM
     ast (2.2.0)
     hpricot (0.8.4)
     metaclass (0.0.4)
-    mime-types (2.99)
+    mime-types (2.99.2)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     parser (2.3.0.1)
       ast (~> 2.2)
     power_assert (0.2.7)
     powerpack (0.1.1)
-    rack (1.6.4)
+    rack (2.0.1)
     rainbow (2.0.0)
     rake (10.5.0)
     redcarpet (3.3.4)
-    roger (1.5.0)
+    roger (1.6.1)
       hpricot (= 0.8.4)
       mime-types (~> 2.2)
       rack (>= 1.0.0)
@@ -39,7 +39,7 @@ GEM
       power_assert
     test_construct (2.0.1)
     thor (0.19.1)
-    tilt (2.0.2)
+    tilt (2.0.5)
 
 PLATFORMS
   ruby
@@ -53,4 +53,4 @@ DEPENDENCIES
   thor (~> 0)
 
 BUNDLED WITH
-   1.10.6
+   1.12.5

data/README.md

@@ -4,12 +4,12 @@ Roger ESLint
 [![Build Status](https://travis-ci.org/DigitPaint/roger_eslint.svg)](https://travis-ci.org/DigitPaint/roger_eslint)
 
 
-Lint JavaScript files from within Roger. This plugin uses [eslint](http://eslint.org/). If present, .eslintrc in your project will be used. If not, jshint will walk the directory tree upwards until a .eslintrc file is found. 
+Lint JavaScript files from within Roger. This plugin uses [eslint](http://eslint.org/). If present, .eslintrc in your project will be used. If not, eslint will walk the directory tree upwards until a .eslintrc file is found. 
 
 ## Installation
-* Install jshint using npm: ```npm install eslint -g```
+* Install eslint using npm: ```npm install eslint -g```
 
-* Add ```gem 'roger_esliint'``` to your Gemfile
+* Add ```gem 'roger_eslint'``` to your Gemfile
 
 * Add this to your Mockupfile:
 ```

data/lib/roger_eslint/lint.rb

@@ -1,4 +1,5 @@
 require "shellwords"
+require "pathname"
 require "json"
 require "roger/test"
 
@@ -31,32 +32,12 @@ module RogerEslint
       @options.update(options) if options
     end
 
-    def lint(test, file_path)
-      output = `#{eslint_command(file_path)}`
-      file_lints = JSON.parse(output).first
+    # @return [Array] failed files
+    def lint(test, file_paths)
+      output = `#{eslint_command(file_paths)}`
+      file_lints = JSON.parse(output)
 
-      unless file_lints
-        test.warn(self, "No files linted")
-        return true
-      end
-
-      success = file_lints["errorCount"] <= 0
-      success &&= file_lints["warningCount"] <= 0 if @_call_options[:fail_on_warning]
-
-      fixables = []
-
-      if success
-        test.log(self, "#{file_path}: OK")
-      else
-        file_lints["messages"].each do |message|
-          fixables << message if message["fix"]
-          report_message(test, file_path, message)
-        end
-      end
-
-      report_fixables(test, file_path, fixables)
-
-      success
+      process_lint_results(test, file_lints)
     end
 
     # @param [Hash] options The options
@@ -69,16 +50,44 @@ module RogerEslint
 
       test.log(self, "ESLinting files")
 
-      failures = test.get_files(@_call_options[:match], @_call_options[:skip]).select do |file_path|
-        !lint(test, file_path)
-      end
-      failures.empty?
+      files = test.get_files(@_call_options[:match], @_call_options[:skip])
+
+      lint(test, files).empty?
     ensure
       @_call_options = {}
     end
 
     private
 
+    def process_lint_results(test, file_lints)
+      if file_lints.empty?
+        test.warn(self, "No files linted")
+        return []
+      end
+
+      file_lints.select do |file_lint|
+        path = file_lint["filePath"]
+
+        success = file_lint["errorCount"] <= 0
+        success &&= file_lint["warningCount"] <= 0 if @_call_options[:fail_on_warning]
+
+        fixables = []
+
+        if success
+          test.log(self, "#{normalize_path(test, path)}: OK")
+        else
+          file_lint["messages"].each do |message|
+            fixables << message if message["fix"]
+            report_message(test, path, message)
+          end
+        end
+
+        report_fixables(test, path, fixables)
+
+        !success
+      end
+    end
+
     def eslint_command(file_path, extras = [])
       command = [
         @_call_options[:eslint],
@@ -88,17 +97,19 @@ module RogerEslint
       command += @_call_options[:eslint_options] if @_call_options[:eslint_options]
 
       command += extras
-      command << file_path
+      if file_path.is_a? Array
+        command += file_path
+      else
+        command << file_path
+      end
 
       Shellwords.join(command)
     end
 
     def report_message(test, file_path, message)
-      output = "#{file_path}: "
-      output << message["line"].to_s
-      output << ":"
-      output << message["column"].to_s
-      output << " ["
+      output = "#{normalize_path(test, file_path)}: "
+      output << "#{message['line']}:#{message['column']} "
+      output << "["
       output << ESLINT_SEVERITIES[message["severity"]]
       output << " (Fixable)" if message["fix"]
       output << "] "
@@ -111,7 +122,7 @@ module RogerEslint
     def report_fixables(test, file_path, fixables)
       if fixables.any?
         test.log(self, "#{fixables.size} problems can be fixed automatically. Run:")
-        test.log(self, "  #{eslint_command(file_path, ['--fix'])}")
+        test.log(self, "  #{eslint_command(normalize_path(test, file_path), ['--fix'])}")
       end
     end
 
@@ -139,6 +150,12 @@ module RogerEslint
         fail ArgumentError, err
       end
     end
+
+    # Will make path relative to project dir
+    # @return [String] relative path
+    def normalize_path(test, path)
+      Pathname.new(path).relative_path_from(test.project.path.realpath).to_s
+    end
   end
 end
 

data/lib/roger_eslint/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 # Roger main namespace
 module RogerEslint
-  VERSION = "1.0.1".freeze
+  VERSION = "1.2.0".freeze
 end

data/test/lint_test.rb

@@ -41,48 +41,60 @@ class LintTest < Test::Unit::TestCase
 
   def test_detect_eslint
     assert_nothing_raised do
-      lint_file "test.js"
+      lint_files "test.js"
     end
 
     assert_raise(ArgumentError) do
-      lint_file "test.js", eslint: "eslint-blabla"
+      lint_files "test.js", eslint: "eslint-blabla"
     end
   end
 
   def test_lint_nonexisting_file
-    success, messages = lint_file("test/data/does_not_exist.js")
+    success, messages = lint_files("test/data/does_not_exist.js")
 
     assert success
     assert_equal "No files linted", messages[0]
   end
 
+  def test_lint_multiple_files
+    success, messages = lint_files(
+      ["test/data/error.js", "test/data/fixable.js"],
+      eslint_options: ["--no-eslintrc", "--rule", "semi: 2"]
+    )
+
+    assert !success
+
+    assert_equal("test/data/error.js: OK", messages[0])
+    assert_equal("test/data/fixable.js: 1:15 [Error (Fixable)] Missing semicolon.", messages[1])
+  end
+
   def test_lint_with_default_eslintrc
     eslintrc_file = ".eslintrc.js"
     assert !File.exist?(eslintrc_file), ".eslintrc.js file already exists."
     FileUtils.cp("./test/data/.eslintrc-no-undef.js", eslintrc_file)
 
     file = "test/data/error.js"
-    success, messages = lint_file(file)
+    success, messages = lint_files(file)
 
     assert !success
 
-    assert_equal("#{file}: 1:1 [Error] \"x\" is not defined.", messages[0])
-    assert_equal("#{file}: 2:1 [Error] \"alert\" is not defined.", messages[2])
-    assert_equal("#{file}: 2:7 [Error] \"x\" is not defined.", messages[4])
+    assert_equal("#{file}: 1:1 [Error] 'x' is not defined.", messages[0])
+    assert_equal("#{file}: 2:1 [Error] 'alert' is not defined.", messages[2])
+    assert_equal("#{file}: 2:7 [Error] 'x' is not defined.", messages[4])
   ensure
     File.unlink eslintrc_file
   end
 
   def test_lint_pass_eslint_options
     file = "test/data/globals.js"
-    success, messages = lint_file(file, eslint_options: ["--no-eslintrc", "--global", "my_global"])
+    success, messages = lint_files(file, eslint_options: ["--no-eslintrc", "--global", "my_global"])
     assert success
     assert_equal "#{file}: OK", messages[0]
   end
 
   def test_lint_fixable_errors
     file = "test/data/fixable.js"
-    success, messages = lint_file(file, eslint_options: ["--no-eslintrc", "--rule", "semi: 2"])
+    success, messages = lint_files(file, eslint_options: ["--no-eslintrc", "--rule", "semi: 2"])
     assert !success
     assert_equal "#{file}: 1:15 [Error (Fixable)] Missing semicolon.", messages[0]
     assert_equal "1 problems can be fixed automatically. Run:", messages[2]
@@ -90,9 +102,9 @@ class LintTest < Test::Unit::TestCase
 
   protected
 
-  def lint_file(file, options = {})
+  def lint_files(files, options = {})
     faketester = TesterStub.new
-    faketester.files = [file]
+    faketester.files = files.is_a?(Array) ? files : [files]
 
     linter = RogerEslint::Lint.new options
     success = linter.call(faketester, {})

metadata

@@ -1,103 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: roger_eslint
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Flurin Egger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
 description: |2
@@ -110,7 +110,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .rubocop.yml
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -136,17 +136,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Lint JavaScript files with ESLint within Roger