eslint-rails-ee 1.0

data/config/eslint.json

@@ -0,0 +1,160 @@
+{
+    "ecmaFeatures": {},
+    "parser": "espree",
+    "env": {
+        "browser": false,
+        "node": false,
+        "amd": false,
+        "mocha": false,
+        "jasmine": false
+    },
+
+    "rules": {
+        "no-alert": 2,
+        "no-array-constructor": 2,
+        "no-bitwise": 0,
+        "no-caller": 2,
+        "no-catch-shadow": 2,
+        "no-comma-dangle": 0,
+        "no-cond-assign": 2,
+        "no-console": 2,
+        "no-constant-condition": 2,
+        "no-control-regex": 2,
+        "no-debugger": 2,
+        "no-delete-var": 2,
+        "no-div-regex": 0,
+        "no-dupe-keys": 2,
+        "no-dupe-args": 2,
+        "no-else-return": 0,
+        "no-empty": 2,
+        "no-empty-character-class": 2,
+        "no-eq-null": 0,
+        "no-eval": 2,
+        "no-ex-assign": 2,
+        "no-extend-native": 2,
+        "no-extra-bind": 2,
+        "no-extra-boolean-cast": 2,
+        "no-extra-parens": 0,
+        "no-extra-semi": 2,
+        "no-fallthrough": 2,
+        "no-floating-decimal": 0,
+        "no-func-assign": 2,
+        "no-implied-eval": 2,
+        "no-inline-comments": 0,
+        "no-inner-declarations": [2, "functions"],
+        "no-invalid-regexp": 2,
+        "no-irregular-whitespace": 2,
+        "no-iterator": 2,
+        "no-label-var": 2,
+        "no-labels": 2,
+        "no-lone-blocks": 2,
+        "no-lonely-if": 0,
+        "no-loop-func": 2,
+        "no-mixed-requires": [0, false],
+        "no-mixed-spaces-and-tabs": [2, false],
+        "no-multi-spaces": 2,
+        "no-multi-str": 2,
+        "no-multiple-empty-lines": [0, { "max": 2 }],
+        "no-native-reassign": 2,
+        "no-negated-in-lhs": 2,
+        "no-nested-ternary": 0,
+        "no-new": 2,
+        "no-new-func": 2,
+        "no-new-object": 2,
+        "no-new-require": 0,
+        "no-new-wrappers": 2,
+        "no-obj-calls": 2,
+        "no-octal": 2,
+        "no-octal-escape": 2,
+        "no-path-concat": 0,
+        "no-plusplus": 0,
+        "no-process-env": 0,
+        "no-process-exit": 2,
+        "no-proto": 2,
+        "no-redeclare": 2,
+        "no-regex-spaces": 2,
+        "no-reserved-keys": 0,
+        "no-restricted-modules": 0,
+        "no-return-assign": 2,
+        "no-script-url": 2,
+        "no-self-compare": 0,
+        "no-sequences": 2,
+        "no-shadow": 2,
+        "no-shadow-restricted-names": 2,
+        "no-space-before-semi": 0,
+        "no-spaced-func": 2,
+        "no-sparse-arrays": 2,
+        "no-sync": 0,
+        "no-ternary": 0,
+        "no-trailing-spaces": 2,
+        "no-throw-literal": 0,
+        "no-undef": 1,
+        "no-undef-init": 2,
+        "no-undefined": 0,
+        "no-underscore-dangle": 2,
+        "no-unreachable": 2,
+        "no-unused-expressions": 2,
+        "no-unused-vars": [2, { "vars": "all", "args": "after-used" }],
+        "no-use-before-define": 2,
+        "no-void": 0,
+        "no-var": 0,
+        "no-warning-comments": [0, { "terms": ["todo", "fixme", "xxx"], "location": "start" }],
+        "no-with": 2,
+
+        "block-scoped-var": 0,
+        "brace-style": [0, "1tbs"],
+        "camelcase": 2,
+        "comma-dangle": [2, "never"],
+        "comma-spacing": 2,
+        "comma-style": 0,
+        "complexity": [0, 11],
+        "consistent-return": 2,
+        "consistent-this": [0, "that"],
+        "curly": [2, "all"],
+        "default-case": 0,
+        "dot-notation": [2, { "allowKeywords": true }],
+        "eol-last": 2,
+        "eqeqeq": 2,
+        "func-names": 0,
+        "func-style": [0, "declaration"],
+        "generator-star": 0,
+        "guard-for-in": 0,
+        "handle-callback-err": 0,
+        "indent": 0,
+        "key-spacing": [2, { "beforeColon": false, "afterColon": true }],
+        "keyword-spacing": 2,
+        "max-depth": [0, 4],
+        "max-len": [0, 80, 4],
+        "max-nested-callbacks": [0, 2],
+        "max-params": [0, 3],
+        "max-statements": [0, 10],
+        "new-cap": 2,
+        "new-parens": 2,
+        "one-var": 0,
+        "operator-assignment": [0, "always"],
+        "padded-blocks": 0,
+        "quote-props": 0,
+        "quotes": [1, "double"],
+        "radix": 0,
+        "semi": 2,
+        "semi-spacing": [2, { "before": false, "after": true }],
+        "sort-vars": 0,
+        "space-after-function-name": [0, "never"],
+        "space-after-keywords": [0, "always"],
+        "space-before-blocks": [0, "always"],
+        "space-before-function-parentheses": [0, "always"],
+        "space-in-brackets": [0, "never"],
+        "space-in-parens": [0, "never"],
+        "space-infix-ops": 2,
+        "space-unary-ops": [2, { "words": true, "nonwords": false }],
+        "spaced-line-comment": [0, "always"],
+        "strict": 2,
+        "use-isnan": 2,
+        "valid-jsdoc": 0,
+        "valid-typeof": 2,
+        "vars-on-top": 0,
+        "wrap-iife": 0,
+        "wrap-regex": 0,
+        "yoda": [2, "never"]
+    }
+}

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  unless Rails.env.production?
+    get '/eslint'             => 'eslint#show'
+    get '/eslint/source'      => 'eslint#source',      as: :eslint_source
+    get '/eslint/eslint.json' => 'eslint#config_file', as: :config_file
+  end
+end

data/eslint-rails-ee.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eslint-rails-ee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eslint-rails-ee'
+  spec.version       = ESLintRails::VERSION
+  spec.authors       = ['Justin Force', 'Jon Kessler', 'David Valentine']
+  spec.email         = ['justin.force@appfolio.com', 'jon.kessler@appfolio.com', 'davidlewisrogers3@gmail.com']
+  spec.summary       = %q{A Rails wrapper for ESLint, but ENHANCED!}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/dlvalentine/eslint-rails-ee'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'railties', '>= 3.2'
+  spec.add_dependency 'execjs'
+  spec.add_dependency 'colorize'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'therubyracer'
+end

data/lib/eslint-rails-ee.rb

@@ -0,0 +1,8 @@
+require 'execjs'
+
+require 'eslint-rails-ee/config'
+require 'eslint-rails-ee/engine'
+require 'eslint-rails-ee/runner'
+require 'eslint-rails-ee/text_formatter'
+require 'eslint-rails-ee/version'
+require 'eslint-rails-ee/warning'

data/lib/eslint-rails-ee/config.rb

@@ -0,0 +1,29 @@
+module ESLintRails
+  class Config
+
+    def self.read(force_default: false)
+      self.new(force_default: force_default).send(:read)
+    end
+
+    private
+
+    CONFIG_PATH = 'config/eslint.json'
+    private_constant :CONFIG_PATH
+
+    def initialize(force_default: nil)
+      raise(ArgumentError, 'force_default is required') if force_default.nil?
+
+      @force_default = force_default
+      @custom_file   = Rails.root.join(CONFIG_PATH)
+      @default_file  = ESLintRails::Engine.root.join(CONFIG_PATH)
+    end
+
+    def read
+      config_file.read
+    end
+
+    def config_file
+      (@custom_file.exist? && !@force_default) ?  @custom_file : @default_file
+    end
+  end
+end

data/lib/eslint-rails-ee/engine.rb

@@ -0,0 +1,4 @@
+module ESLintRails
+  class Engine < Rails::Engine
+  end
+end

data/lib/eslint-rails-ee/runner.rb

@@ -0,0 +1,113 @@
+require 'colorize'
+
+module ESLintRails
+  class Runner
+    include ActionView::Helpers::JavaScriptHelper
+
+    JAVASCRIPT_EXTENSIONS = %w(.js .jsx .es6)
+
+    def initialize(file)
+      @file = normalize_infile(file)
+    end
+
+    def run(should_autocorrect=false)
+      warnings = assets.map do |asset|
+        generate_warnings(asset, should_autocorrect).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.map { |path| Pathname.new(path) }.select do |asset|
+        JAVASCRIPT_EXTENSIONS.include?(asset.extname)
+      end
+
+      assets = all_js_assets.select{|a| is_descendant?(@file, a)}
+
+      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 eslint_plugin_js
+      @eslint_plugin_js ||= begin
+        plugins.map do |plugin_name|
+          Rails.application.assets["plugins/eslint-plugin-#{plugin_name}"].to_s
+        end.join('\n')
+      end
+    end
+
+    def plugins
+      JSON.parse(Config.read)['plugins'] || []
+    end
+
+    def warning_hashes(file_content, relative_path, should_autocorrect=false)
+      if !should_autocorrect
+        ExecJS.eval <<-JS
+          function () {
+            window = this;
+            #{eslint_js};
+            #{eslint_plugin_js};
+            return new eslint().verify('#{escape_javascript(file_content)}', #{Config.read});
+          }()
+        JS
+      else
+        hsh = ExecJS.eval <<-JS
+        function () {
+          window = this;
+          #{eslint_js};
+          #{eslint_plugin_js};
+          return new eslint().verifyAndFix('#{escape_javascript(file_content)}', #{Config.read});
+        }()
+        JS
+        File.write(relative_path, hsh['output']) if !hsh['output'].nil?
+        hsh['messages']
+      end
+    end
+
+    def generate_warnings(asset, should_autocorrect=false)
+      relative_path = asset.relative_path_from(Pathname.new(Dir.pwd))
+      file_content  = asset.read
+
+      warning_hashes(file_content, relative_path, should_autocorrect).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-ee/text_formatter.rb

@@ -0,0 +1,43 @@
+require 'active_support/core_ext/string/strip'
+require 'colorize'
+
+module ESLintRails
+  class TextFormatter
+
+    def initialize(warnings)
+      @warnings = warnings
+    end
+
+    def format(should_autocorrect=false)
+      max_line_column_length = max_length_of_attribute(:location)
+      max_rule_id_length = max_length_of_attribute(:rule_id)
+      max_message_length = max_length_of_attribute(:message)
+      @warnings.each do |warning|
+        message = [
+          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)
+        ].join(" ")
+        colorized_message =
+          case warning.severity
+          when :low
+            message.yellow
+          when :high
+            message.red
+          else
+            raise 'Couldn\'t figure out how to format this mess. Stahp.'
+          end
+        puts colorized_message
+      end
+
+      puts "#{@warnings.size} warning(s) found #{should_autocorrect ? 'after auto-correcting some issues' : ''}"
+    end
+
+    private
+
+    def max_length_of_attribute(attr_key)
+      @warnings.map { |warning| warning.send(attr_key).size }.max
+    end
+  end
+end

data/lib/eslint-rails-ee/version.rb

@@ -0,0 +1,3 @@
+module ESLintRails
+  VERSION = '1.0'.freeze
+end

data/lib/eslint-rails-ee/warning.rb

@@ -0,0 +1,34 @@
+module ESLintRails
+  class Warning
+    attr_reader :filename, :line, :column, :node_type
+
+    SEVERITY = [ :low, :high ].freeze
+    private_constant :SEVERITY
+
+    def initialize(filename, warning_hash)
+      @filename = filename
+      @rule_id = warning_hash['ruleId'] || "unexpected error"
+      @severity = warning_hash['severity']
+      @message = warning_hash['message']
+      @line = warning_hash['line']
+      @column = warning_hash['column']
+      @node_type = warning_hash['nodeType']
+    end
+
+    def severity
+      SEVERITY[@severity-1]
+    end
+
+    def location
+      "#{filename}:#{line}:#{column}"
+    end
+
+    def rule_id
+      @rule_id || 'N/A'
+    end
+
+    def message
+      @message || 'N/A'
+    end
+  end
+end

data/lib/tasks/eslint.rake

@@ -0,0 +1,50 @@
+ENV['EXECJS_RUNTIME'] = 'RubyRacer'
+
+require 'eslint-rails-ee'
+
+namespace :eslint do
+  def run_and_print_results(file, should_autocorrect=false)
+    warnings   = ESLintRails::Runner.new(file).run(should_autocorrect)
+    raiseError = false
+
+    warnings.each do |warning|
+      next if warning.severity.nil?
+      if warning.severity.to_s.casecmp('high').zero?
+        raiseError = true
+        break
+      end 
+    end
+
+    if warnings.empty?
+      puts 'All files passed! Any issues that might have existed may have been auto-corrected :)'.green
+      exit 0
+    elsif !raiseError
+      formatter = ESLintRails::TextFormatter.new(warnings)
+      puts formatter.format(should_autocorrect)
+      puts 'eslint reports some warnings, but they are minor enough to be passable. Might want to fix them up before release, though. :/'.yellow
+      exit 0
+    else
+      formatter = ESLintRails::TextFormatter.new(warnings)
+      puts formatter.format(should_autocorrect)
+      puts 'Major issues exist according to provided eslint rules. You *MUST* git gud and correct these issues before release :('.red
+      exit 1
+    end
+  end
+
+  desc %{Run ESLint against the specified JavaScript file and report warnings (default is 'application')}
+  task :run, [:filename, :should_autocorrect] => :environment do |_, args|
+    formatted_should_autocorrect = ['true'].include?(args[:should_autocorrect]) ? true : false
+    run_and_print_results(args[:filename] || 'application', formatted_should_autocorrect)
+  end
+
+  desc 'Run ESLint against all project javascript files and report warnings'
+  task :run_all, [:should_autocorrect] => :environment do |_, args|
+    formatted_should_autocorrect = ['true'].include?(args[:should_autocorrect]) ? true : false
+    run_and_print_results(nil, formatted_should_autocorrect) # 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])
+  end
+end