eslint-rails 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a72fcfdebdae83dcc61832c1d38fdf48dd6bf68
-  data.tar.gz: 2cd33b71cb583ab5a2c3662ddda5c768c0115e05
+  metadata.gz: a225cfc475435f30b32752520bc9d542e92d4734
+  data.tar.gz: 59b7cf5158a98e762febff32834c91f4b3e6a2fe
 SHA512:
-  metadata.gz: 0d773e32beb13c5a3daf0001a354ff4218b0920ed1fcc6e1c6854898e844620879d4f8e160b02e3e77a0823ed3aa2f8d269a25fb588765b5dbad09efd070931f
-  data.tar.gz: 2dacc23af60766cb8d7d255a212417833d0bf11d033d4dfc6b701952b576b9552fde4a4d82ef570b56ae4bc05fbd833cb6dd5904f3b351bbac7c04c2577f3ea9
+  metadata.gz: 3aeb4cd0968fa89ae1430d065f5de8fcb1f490d6f0f9e76e22f376331f7b1d49caee5717676fdd1c7eaef70a6cc1be91edd303f84f3352f30a878e8d6ce82307
+  data.tar.gz: 1df9381c4a7c723b0a111f744a36726dd897c571f7a4e8f680142d18c28ee1d384a2dca276cf08c3e8fbf39fc0b341112afbec12d3766cc23fe1f7f20f3bd534

data/README.md

@@ -36,17 +36,25 @@ in your browser. To force retrieval of the default conguration, use
 
 ![rake-eslint-rails-run][]
 
+This will analyze all of the javascript files in the project:
+
+```sh
+rake eslint:run_all
+```
+
+Or you can run it on a single file. This will analyze `application.js`:
+
 ```sh
 rake eslint:run
 ```
 
-This will analyze `application.js`. Optionally, you can supply a filename to the
-task. To analyze `components/woop.js` and `utilities.js.coffee.erb` you would
-run (respectively):
+Or, you can supply a filename to the task, using several different formats, and it will lint just that file. For example, to analyze `app/assets/javascripts/components/utilities.js`, you can run any of the following:
 
 ```sh
-rake eslint:run[components/woop]
-rake eslint:run[utilities]
+rake eslint:run[components/utilities]
+rake eslint:run[components/utilities.js]
+rake eslint:run[app/assets/javascripts/components/utilities]
+rake eslint:run[app/assets/javascripts/components/utilities.js]
 ```
 
 ### Web interface

data/lib/eslint-rails/runner.rb

@@ -1,24 +1,83 @@
+require 'colorize'
+
 module ESLintRails
   class Runner
     include ActionView::Helpers::JavaScriptHelper
 
-    def initialize(filename)
-      @filename = filename || 'application'
+    def initialize(file)
+      @file = normalize_infile(file)
     end
 
     def run
-      file_content = Rails.application.assets[@filename].to_s
-
-      eslint_js = Rails.application.assets['eslint'].to_s
+      warnings = assets.map do |asset|
+        generate_warnings(asset).tap { |warnings| output_progress(warnings) }
+      end
+      
+      puts
+      
+      warnings.flatten
+    end
+    
+    private
+    
+    def normalize_infile(file)
+      file = file.to_s.gsub(/^app\/assets\/javascripts\//, '') # Remove beginning of asset path
+      file = Pathname.new("#{Dir.pwd}/app/assets/javascripts/#{file}") # Ensure path is absolute
+      file = Pathname.new("#{file}.js") if !file.directory? && file.extname.empty? # Make sure it has an extension
+      file
+    end
+    
+    def assets
+      all_js_assets = Rails.application.assets.each_file.to_a.select { |pn| pn.extname == '.js' }
+      
+      assets = all_js_assets.select{|a| is_descendant?(@file, a)}
 
-      warning_hashes = ExecJS.eval <<-JS
+      assets.reject{|a| a.to_s =~ /eslint.js|vendor|gems|min.js|editorial/ }
+    end
+    
+    def eslint_js
+      @eslint_js ||= Rails.application.assets['eslint'].to_s
+    end
+    
+    def warning_hashes(file_content)
+      ExecJS.eval <<-JS
         function () {
           window = this;
           #{eslint_js};
-          return eslint.verify('#{escape_javascript file_content}', #{Config.read});
+          return eslint.verify('#{escape_javascript(file_content)}', #{Config.read});
         }()
       JS
-      warning_hashes.map{|hash| ESLintRails::Warning.new(hash)}
+    end
+    
+    def generate_warnings(asset)
+      relative_path = asset.relative_path_from(Pathname.new(Dir.pwd))
+      file_content = asset.read
+      
+      warning_hashes(file_content).map do |hash|
+        ESLintRails::Warning.new(relative_path, hash)
+      end
+    end
+    
+    def output_progress(warnings)
+      print case file_severity(warnings)
+            when :high
+              'H'.red
+            when :low
+              'L'.yellow
+            else
+              '.'.green
+            end
+    end
+    
+    def file_severity(warnings)
+      warnings.map(&:severity).uniq.sort.first
+    end
+    
+    def is_descendant?(a, b)
+      a_list = a.to_s.split('/')
+      b_list = b.to_s.split('/')
+
+      b_list[0..a_list.size-1] == a_list
     end
   end
 end

data/lib/eslint-rails/text_formatter.rb

@@ -4,21 +4,17 @@ require 'colorize'
 module ESLintRails
   class TextFormatter
 
-    WARNING_TEMPLATE = <<-TEXT.strip_heredoc
-      <%= line %>,<%= column %> <%= severity %>! [<%= rule_id %>] <%= message %>
-    TEXT
-
     def initialize(warnings)
       @warnings = warnings
     end
 
     def format
-      max_line_column_length = @warnings.map { |warning| (warning.line + warning.column).size }.max
+      max_line_column_length = @warnings.map { |warning| warning.location.size }.max
       max_rule_id_length = @warnings.map { |warning| warning.rule_id.size }.max
       max_message_length = @warnings.map { |warning| warning.message.size }.max
       @warnings.each do |warning|
         message = [
-          "#{warning.line}:#{warning.column}".ljust(max_line_column_length + 1),
+          warning.location.ljust(max_line_column_length + 1),
           warning.severity.to_s.ljust(6),
           warning.rule_id.ljust(max_rule_id_length),
           warning.message.ljust(max_message_length)

data/lib/eslint-rails/version.rb

@@ -1,3 +1,3 @@
 module ESLintRails
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/eslint-rails/warning.rb

@@ -1,11 +1,12 @@
 module ESLintRails
   class Warning
-    attr_reader :rule_id, :message, :line, :column, :node_type
+    attr_reader :filename, :rule_id, :message, :line, :column, :node_type
 
     SEVERITY = [ :low, :high ].freeze
     private_constant :SEVERITY
 
-    def initialize(warning_hash)
+    def initialize(filename, warning_hash)
+      @filename = filename
       @rule_id = warning_hash['ruleId'] || "unexpected error"
       @severity = warning_hash['severity']
       @message = warning_hash['message']
@@ -17,5 +18,9 @@ module ESLintRails
     def severity
       SEVERITY[@severity-1]
     end
+
+    def location
+      "#{filename}:#{line}:#{column}"
+    end
   end
 end

data/lib/tasks/eslint.rake

@@ -3,10 +3,8 @@ ENV['EXECJS_RUNTIME'] = 'RubyRacer'
 require 'eslint-rails'
 
 namespace :eslint do
-
-  desc %{Run ESLint against the specified JavaScript file and report warnings (default is 'application')}
-  task :run, [:filename] => :environment do |_, args|
-    warnings = ESLintRails::Runner.new(args[:filename]).run
+  def run_and_print_results(file)
+    warnings = ESLintRails::Runner.new(file).run
 
     if warnings.empty?
       puts 'All good! :)'.green
@@ -18,6 +16,16 @@ namespace :eslint do
     end
   end
 
+  desc %{Run ESLint against the specified JavaScript file and report warnings (default is 'application')}
+  task :run, [:filename] => :environment do |_, args|
+    run_and_print_results(args[:filename] || 'application')
+  end
+
+  desc 'Run ESLint against all project javascript files and report warnings'
+  task run_all: :environment do |_, args|
+    run_and_print_results(nil) # Run all
+  end
+
   desc 'Print the current configuration file (Uses local config/eslint.json if it exists; uses default config/eslint.json if it does not; optionally force default by passing a parameter)'
   task :print_config, [:force_default] => :environment do |_, args|
     puts ESLintRails::Config.read(force_default: args[:force_default])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eslint-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Justin Force
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties