eslint-rails 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 522127e2bb834cbd61737940076956bae357a2f5
-  data.tar.gz: 11dfe715b25b8ce80305534ac3d55aabc0d9aa88
+  metadata.gz: a6072d625ed03699ed2dd021a321c9c275de1dc8
+  data.tar.gz: 21ecfadcbeab3db2bd345651eb9ce60bbf566b24
 SHA512:
-  metadata.gz: 46f1202a57e3662a5c80245a5c6d8d511a0fd2959c17a822f1a96ae0c53c8f349fc1f10e6706c54624de08dd6292087a643be4e40568a48369b142812ea04f16
-  data.tar.gz: 1f29e688832ba7a5734ad0c03310c50469b709533dbec75f5c41fe54134f80d403e01a361efc523cac692ec99b91bf2bdcafb922266cd756fc7ebfc04a16cfcb
+  metadata.gz: 44cd898801950e5a480a461bd4766fa11338f2d6c0099dd13d2c56cb51faa0d655f777179575aae6b12d18d673c5875af809f881f845ce8f00198eac1bdd209b
+  data.tar.gz: b2313f4b9173ec07cfc17411695f0d60e9c5a78d81d7e4acfe964726dabacde8ad8839f19a3b6e3b3c9f4942596586a348267b0f9c2b69c816327247924e4809

data/README.md

@@ -10,6 +10,26 @@ Add this line to your application's Gemfile:
 gem 'eslint-rails'
 ```
 
+## Configuration
+
+To customize configuration, place an eslint config file in your app's
+`config/eslint.json`.
+
+You can print the configuration thusly:
+
+```sh
+# Print the configuration that we're using. If there's a custom configuration
+# present, print that; if not, print the default configuration.
+rake eslint:print_config
+
+# Or print the default configuration even if a custom one exists.
+rake eslint:print_config[true]
+```
+
+You can also retrieve the current eslint.json by visiting `/eslint/eslint.json`
+in your browser. To force retrieval of the default conguration, use
+`/eslint/eslint.json?force_default=true`.
+
 ## Usage
 
 ### CLI
@@ -21,25 +41,27 @@ rake eslint:run
 ```
 
 This will analyze `application.js`. Optionally, you can supply a filename to the
-task. To analyze `woop.js`, you would run
+task. To analyze `components/woop.js` and `utilities.js.coffee.erb` you would
+run (respectively):
 
 ```sh
-rake eslint:run[woop]
+rake eslint:run[components/woop]
+rake eslint:run[utilities]
 ```
 
 ### Web interface
 
 On non-production environments, visit these URLs on your application:
 
-Path                         | Description
----------------------------- | -------------------------------------------------
-`/eslint`                    | Optionally supply a filename parameter to analyze a file other than `application.js`, e.g.  `/eslint?filename=foo` to analyze foo.js.
-`/eslint/source/application` | Optionally replace `application` with the name of another JavaScript file, e.g.  `eslint/source/button_stuff` will show you `button_source.js`.
-
-![eslint-rails-web-source](https://cloud.githubusercontent.com/assets/324632/6671965/33d6819c-cbc6-11e4-9a64-30be84f20b96.png)
+Path                                  | Description
+------------------------------------- | -------------------------------------------------
+`/eslint`                             | Optionally supply a filename parameter to analyze a file other than `application.js`, e.g.  `/eslint?filename=foo` to analyze foo.js.
+`/eslint/source?filename=application` | Optionally replace `application` with the name of another JavaScript file, e.g.  `eslint/source?filename=button_stuff` can show you `button_stuff.js`, and `eslint/source?filename=components/buttons/icon_button` can show you `components/buttons/icon_button.js.coffee.erb`.
 
 ![eslint-rails-web](https://cloud.githubusercontent.com/assets/324632/6671966/33d8cc86-cbc6-11e4-904d-3379907c429d.png)
 
+![eslint-rails-web-source](https://cloud.githubusercontent.com/assets/324632/6671965/33d6819c-cbc6-11e4-9a64-30be84f20b96.png)
+
 # Authors
 
 - Jon Kessler <[jon.kessler@appfolio.com][]>
@@ -54,6 +76,6 @@ Path                         | Description
 [jon.kessler@appfolio.com]: mailto:jon.kessler@appfolio.com
 [MIT License]: http://www.opensource.org/licenses/MIT)
 
-[rake-eslint-rails-run]: https://cloud.githubusercontent.com/assets/324632/6671891/b5b92760-cbc5-11e4-8a3c-12c19ccfbb4d.png
+[rake-eslint-rails-run]: https://cloud.githubusercontent.com/assets/324632/6672146/9d1f278e-cbc7-11e4-9f56-5a4511d35921.png
 [eslint-rails-web-source]: https://cloud.githubusercontent.com/assets/324632/6671965/33d6819c-cbc6-11e4-9a64-30be84f20b96.png
 [eslint-rails-web]: https://cloud.githubusercontent.com/assets/324632/6671966/33d8cc86-cbc6-11e4-904d-3379907c429d.png

data/app/controllers/eslint_controller.rb

@@ -10,6 +10,10 @@ class EslintController < ActionController::Base
     @source = Rails.application.assets[@filename].to_s
   end
 
+  def config_file
+    render json: ESLintRails::Config.read(force_default: params[:force_default])
+  end
+
   private
 
   def set_filename

data/app/views/eslint/show.html.erb

@@ -11,7 +11,12 @@
 </head>
 <body>
   <div class="container">
-    <h1>ESLint Report</h1>
+    <h1>
+      ESLint Report
+      <small>
+        <%= link_to 'eslint.json', config_file_path %>
+      </small>
+    </h1>
     <table class="table">
       <thead>
         <tr>
@@ -36,7 +41,7 @@
           <tr class="<%= row_class %>">
             <td><%= link_to(
                       "#{warning.line}:#{warning.column}",
-                      eslint_source_path(@filename, anchor: warning.line)
+                      eslint_source_path(filename: @filename, anchor: warning.line)
                     ) %></td>
             <td><%= warning.severity.to_s.capitalize %></td>
             <td><%= link_to warning.rule_id, "http://eslint.org/docs/rules/#{warning.rule_id}.html" %></td>

data/config/routes.rb

@@ -1,6 +1,7 @@
 Rails.application.routes.draw do
   unless Rails.env.production?
-    match '/eslint' => 'eslint#show', via: :get
-    match '/eslint/source/:filename' => 'eslint#source', via: :get, as: :eslint_source
+    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/lib/eslint-rails.rb

@@ -1,5 +1,6 @@
 require 'execjs'
 
+require 'eslint-rails/config'
 require 'eslint-rails/engine'
 require 'eslint-rails/runner'
 require 'eslint-rails/text_formatter'

data/lib/eslint-rails/config.rb

@@ -0,0 +1,27 @@
+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:)
+      @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/runner.rb

@@ -10,13 +10,12 @@ module ESLintRails
       file_content = Rails.application.assets[@filename].to_s
 
       eslint_js = Rails.application.assets['eslint'].to_s
-      config = ESLintRails::Engine.root.join('config/eslint.json').read
 
       warning_hashes = ExecJS.eval <<-JS
         function () {
           window = this;
           #{eslint_js};
-          return eslint.verify('#{escape_javascript file_content}', #{config});
+          return eslint.verify('#{escape_javascript file_content}', #{Config.read});
         }()
       JS
       warning_hashes.map{|hash| ESLintRails::Warning.new(hash)}

data/lib/eslint-rails/version.rb

@@ -1,3 +1,3 @@
 module ESLintRails
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/tasks/eslint.rake

@@ -5,7 +5,7 @@ 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 |task, args|
+  task :run, [:filename] => :environment do |_, args|
     warnings = ESLintRails::Runner.new(args[:filename]).run
 
     if warnings.empty?
@@ -17,4 +17,9 @@ namespace :eslint do
       exit 1
     end
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eslint-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Force
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -115,6 +115,7 @@ files:
 - config/routes.rb
 - eslint-rails.gemspec
 - lib/eslint-rails.rb
+- lib/eslint-rails/config.rb
 - lib/eslint-rails/engine.rb
 - lib/eslint-rails/runner.rb
 - lib/eslint-rails/text_formatter.rb
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Rails wrapper for ESLint.