eslint-rails-ee 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f8dda485adf47335a2d7ee6ea66b17fd5b0ee2b
+  data.tar.gz: 35e48b79e17394be368e491dfb630d63bd2912cd
+SHA512:
+  metadata.gz: f9c66719fc1886b05d35c0730f46fbd00217bbae09889a1decdb19dc352d22795fd04af935aaaf045f43e9b15897be4f674fa3f85b6d4cc1d9ad9804c6be1b20
+  data.tar.gz: 5d80f57cb3436a70132dc29aaddc7432707bccaa3dadc138e1f02269e94da44b7a594bbf4714736b7d2a3301fc2f63751763fb726784cadb420c54eb4215aaf6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eslint-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 AppFolio, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,216 @@
+# eslint-rails-ee: a fork of eslint-rails with enhanced features
+
+Run [ESLint][] against your Rails repo, and even auto-correct issues! The supported javascript file extensions are the following:
+
+- _.js_
+- _.jsx_
+- _.es6_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eslint-rails-ee'
+gem 'therubyracer'
+gem 'execjs'
+```
+
+This uses TheRubyRacer as a runtime. For most environments, this works fine. However if you run windows do this to your gemfile:
+
+```ruby
+gem 'eslint-rails-ee'
+gem 'therubyracer', :platforms => :ruby
+gem 'execjs'
+```
+
+## 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
+
+![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
+```
+
+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/utilities]
+rake eslint:run[components/utilities.js]
+rake eslint:run[app/assets/javascripts/components/utilities]
+rake eslint:run[app/assets/javascripts/components/utilities.js]
+```
+
+To auto-correct files in either execution of the above rake tasks just add `true` to the arguments like so:
+
+```sh
+rake eslint:run_all[true]
+```
+or
+
+```sh
+rake eslint:run[test.js,true]
+```
+
+### 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?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`. This returns the source code with syntax highlighting
+`/eslint?filename=<path+filename>`    | Providing you give a correct path/filename, it will run the eslint report and show you the errors
+`/eslint?filename=<path+filename>&should_autocorrect=true` | Same as above, but will report errors AFTER auto-correcting any auto-correct-able issues
+
+![eslint-rails-web][]
+
+![eslint-rails-web-source][]
+
+# Contributing
+
+It's easiest to contribute by forking the repo and creating a pull request. For
+help with this, see this [helpful article][fork a repo].
+
+For all of the example shell commands below, I'm going to assume that you've set
+these two variables, so go ahead and customize these and set them before you
+start.
+
+```sh
+ESLINT=~/src/eslint
+ESLINT_RAILS=~/src/eslint-rails
+```
+
+## Cloning the repository
+
+```sh
+git clone https://github.com/appfolio/eslint-rails-ee $ESLINT_RAILS
+```
+
+## Updating ESLint version
+
+### Summary
+
+1. [Clone the ESLint repository](#clone-the-eslint-repository)
+2. [Install dependencies](#install-dependencies)
+3. [Render `eslint.js`](#render-eslintjs)
+4. [Copy `eslint.js` into `eslint-rails`](#copy-eslintjs-into-eslint-rails)
+5. [Update the file in git](#update-the-file-in-git)
+6. [Commit, push, and create a pull request](#commit-push-and-create-a-pull-request)
+
+### Step-by-step instructions
+
+First, make sure you set the environment variables [as suggested above](#contributing).
+
+#### Clone the [ESLint repository][]
+
+I would recommend only trying this with a released version unless you have a
+good reason to. In this example, I'm going to check out v1.10.1 and work with
+that.
+
+```sh
+git clone https://github.com/eslint/eslint $ESLINT
+cd $ESLINT
+git checkout v1.10.1
+```
+
+#### Install dependencies
+
+```sh
+cd $ESLINT
+npm install
+```
+
+#### Render `eslint.js`
+
+```sh
+cd $ESLINT
+node Makefile.js browserify
+```
+
+#### Copy `eslint.js` into `eslint-rails`
+
+```sh
+# Assuming you cloned eslint into a repository next to eslint-rails
+cp $ESLINT/build/eslint.js $ESLINT_RAILS/vendor/assets/javascripts/eslint.js
+```
+
+#### Update the file in git
+
+```sh
+cd $ESLINT_RAILS
+git add vendor/assets/javascripts/eslint.js
+```
+
+#### Commit, push, and create a pull request
+
+The details of how to create your own branch, commit, push, and create a pull
+request are outside the scope of this README. If you need help with this part,
+here's a [helpful article][fork a repo]. This is the gist.
+
+```sh
+cd $ESLINT_RAILS
+# Make your changes
+git add :/
+git commit
+git push origin master
+# Open a pull request
+```
+# Fork Authors
+
+Since the original repo lacked some features I wanted and hasn't seen support/PRs in over a year, I decided to make this repo. Future maintenance of this gem will exist in 
+the new eslint-rails-ee repo: 
+
+- David Valentine &lt;[davidlewisrogers3@gmail.com][]&gt;
+
+# Original Authors
+
+This repo was orignially written by the following people:
+
+- Jon Kessler &lt;[jon.kessler@appfolio.com][]&gt;
+- Justin Force &lt;[justin.force@appfolio.com][]&gt;
+
+# License
+
+[MIT License][].
+
+[ESLint]: http://eslint.org/
+[fork a repo]: https://help.github.com/articles/fork-a-repo/
+[ESLint repository]: https://github.com/eslint/eslint
+[justin.force@appfolio.com]: mailto:justin.force@appfolio.com
+[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/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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/eslint_controller.rb

@@ -0,0 +1,23 @@
+class EslintController < ActionController::Base
+
+  before_action :set_options
+
+  def show
+    @warnings = ESLintRails::Runner.new(@filename).run(@should_autocorrect)
+  end
+
+  def source
+    @source = Rails.application.assets[@filename].to_s
+  end
+
+  def config_file
+    render json: ESLintRails::Config.read(force_default: params[:force_default] || false)
+  end
+
+  private
+
+  def set_options
+    @filename = params[:filename] || 'application'
+    @should_autocorrect = ['true'].include?(params[:should_autocorrect]) ? true : false
+  end
+end

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

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">
+  <style>
+    .container {
+      margin: 0 auto;
+      width: 980px;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <h1>
+      ESLint Report <%= "(after auto-corrections)" if params[:should_autocorrect] %>
+      <small>
+        <%= link_to 'eslint.json', config_file_path %>
+      </small>
+    </h1>
+    <table class="table">
+      <thead>
+        <tr>
+          <th>Location</th>
+          <th>Severity</th>
+          <th>Rule</th>
+          <th>Message</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @warnings.each do |warning| %>
+          <%
+             row_class = case warning.severity
+             when :low
+               'warning'
+             when :high
+               'danger'
+             else
+               ''
+             end
+          %>
+          <tr class="<%= row_class %>">
+            <td><%= link_to(
+                      "#{warning.line}:#{warning.column}",
+                      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>
+            <td><%= warning.message %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</body>
+</html>

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

@@ -0,0 +1,80 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/github.min.css">
+  <style>
+    .container {
+      display: flex;
+    }
+
+    .line-numbers {
+      padding-right: 0.5em;
+    }
+
+    .line-numbers > a {
+      color: #000;
+      display: block;
+      font-family: monospace;
+      text-align: right;
+      text-decoration: none;
+    }
+
+    .line-numbers > a.current {
+      color: orangered;
+      outline: none;
+    }
+
+    .line-numbers > a.current:after {
+      content: '';
+      position: absolute;
+      left: 0;
+      right: 100%;
+      width: 100vw;
+      height: 12px;
+      background: #ff9;
+      z-index: -1;
+    }
+
+    .the-code {
+      flex: 1;
+      margin: 0;
+    }
+
+    .hljs {
+      background: rgba(0,0,0,0.01);
+      padding: 0;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <div class="line-numbers">
+      <% 1.upto(@source.lines.size) do |line_number| %>
+        <a id="<%= line_number %>" href="#<%= line_number %>" class="line-number"><%= line_number %></a>
+      <% end %>
+    </div>
+    <pre class="the-code hljs javascript"><code><%= @source %></code></pre>
+  </div>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/highlight.min.js"></script>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/languages/javascript.min.js"></script>
+  <script>
+    (function() {
+      hljs.initHighlightingOnLoad();
+
+      function selectCurrentLine() {
+        var hash = location.hash
+          , currentLineNumber = hash.replace(/#/, '');
+        Array.prototype.slice.call(document.querySelectorAll('.line-number')).forEach(function(lineNumber) {
+          lineNumber.classList.remove('current');
+        });
+        document.getElementById(currentLineNumber).classList.add('current');
+      }
+
+      if (location.hash) {
+        selectCurrentLine();
+      }
+      window.addEventListener('hashchange', selectCurrentLine);
+    }())
+  </script>
+</body>
+</html>

data/build-plugins.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+ESLINT_RAILS_DIR=$(pwd)
+PLUGINS=(yannickcr/eslint-plugin-react) # Add new plugins here.
+GIT_URL_PREFIX="git@github.com:"
+GIT_URL_SUFFIX=".git"
+
+mkdir -p /tmp/eslint-rails-plugins
+cd /tmp/eslint-rails-plugins
+
+for plugin in ${PLUGINS[@]}; do
+  git_url=$GIT_URL_PREFIX$plugin$GIT_URL_SUFFIX
+  git clone $git_url
+  plugin_name=$(basename $git_url .git)
+  cd $plugin_name
+  npm install
+  browserify index.js -o $plugin_name.js
+  cp $plugin_name.js $ESLINT_RAILS_DIR/vendor/assets/javascripts/plugins/
+done
+
+rm -rf /tmp/eslint-rails-plugins