eslint-webpacker 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c862f7643f282334fe5b6e3858ac3a1186d561df164245d01931e7e0204bfebd
+  data.tar.gz: 2a098fd6df1905629206b729c6675be84985539d5c85bfea2079a605d228c60b
+SHA512:
+  metadata.gz: 48d83f8ea6260c95fd6a582fb7d2d4cdcb1829a6aa6be87dcd9ad0ca66b46aadf03c9da63b573f7d58d8f4e1f59a82556c6ac892db766d41b6e071a1f59b9fa6
+  data.tar.gz: ec22a9ce7d9f7f1d8cff02e73c751a1ba442a25d34d1dac10b4a812bc4b08295ffd5c9b210d84f211e74e2dc78e60525edb39025ecd35c67d11f53a6903f82bd

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/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+    NewCops: enable
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+
+Layout/LineLength:
+  Max: 80
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: Yes
+  PreferredName: error
+
+Style/Documentation:
+  Enabled: No

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+
+
+## [1.0.1] - 2021-03-22
+### Fixed
+- Version file loading from gemspec file
+
+## [1.0.0] - 2021-03-22
+### Fixed
+- Initial import running `eslint` or `eslint_d`
+
+
+[Unreleased]: https://gitlab.com/zedtux/eslint-webpacker/-/compare/v1.0.1...master
+[1.0.1]: https://gitlab.com/zedtux/eslint-webpacker/-/compare/v1.0.0...v1.0.1
+[1.0.0]: https://gitlab.com/zedtux/eslint-webpacker/-/tags/v1.0.0

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,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Guillaume Hain
+
+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,70 @@
+# eslint-webpacker
+
+A Ruby on Rails gem that runs `eslint` (https://eslint.org/) from the `node_modules` folder built with [the webpacker gem](https://github.com/rails/webpacker).
+
+I've made this gem in order to use it in my project's `Rakefile` so that it checks the javascript files, like [rubocop](https://github.com/rubocop/rubocop) does for Ruby files.
+
+Supported file extensions are:
+
+- _.js_
+- _.jsx_
+- _.es6_
+
+This repo is a fork of [the eslint-rails gem](https://github.com/appfolio/eslint-rails).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'eslint-rails'
+end
+```
+
+If not already done, install the `eslint` package and configure your plugins. Also see bellow if it's too slow.
+
+## Usage
+
+### CLI
+
+This gem comes with one Rake task:
+
+```sh
+rake eslint:run
+```
+
+Ran like this, it will scan all the JavaScript files from your project.
+
+But you can supply a filename to the task, using several different formats, and it will lint just that file. For example, to analyze `app/javascript/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/javascript/components/utilities]
+rake eslint:run[app/javascript/components/utilities.js]
+```
+
+## But it is really slow!
+
+You are using the `eslint` NPM package which requires to boot Node JS for each files.
+
+In order to speed up the checks, install [estlint_d](https://github.com/mantoni/eslint_d.js) which runs ESlint in a daemon :
+
+```
+yarn add eslint_d
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/zedtux/eslint-webpacker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/eslint-webpacker.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/eslint-webpacker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eslint-webpacker'
+  spec.version       = ESLintWebpacker::VERSION
+  spec.authors       = ['Guillaume Hain']
+  spec.email         = ['zedtux@zedroot.org']
+  spec.summary       = 'Runs eslint or eslint_d from Ruby'
+  spec.description   = 'This gem is useful when added to the Rakefile in ' \
+                       'order to scan each of your JavaScript files in a ' \
+                       'Ruby On Rails project using the webpacker gem.'
+  spec.homepage      = 'https://gitlab.com/zedtux/eslint-webpacker'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}-/blob/master/CHANGELOG.md"
+
+  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.4'
+
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'railties', '>= 3.2'
+  spec.add_dependency 'webpacker'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/eslint-webpacker.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eslint-webpacker/engine'
+require 'eslint-webpacker/runner'
+require 'eslint-webpacker/text_formatter'
+require 'eslint-webpacker/version'
+require 'eslint-webpacker/warning'

data/lib/eslint-webpacker/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ESLintRails
+  class Engine < Rails::Engine
+  end
+end

data/lib/eslint-webpacker/runner.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+module ESLintWebpacker
+  class Runner
+    include ActionView::Helpers::JavaScriptHelper
+
+    JAVASCRIPT_EXTENSIONS = %w[.js .jsx .es6].freeze
+
+    def initialize(file)
+      @file = normalize_infile(file)
+    end
+
+    def run
+      javascripts = javascript_files
+
+      puts "Inspecting #{javascripts.size} files"
+
+      warnings = javascripts.map do |javascript|
+        generate_warnings(javascript).tap { |warns| output_progress(warns) }
+      end
+
+      puts
+
+      warnings.flatten
+    end
+
+    private
+
+    def descendant?(file_a, file_b)
+      a_list = file_a.to_s.split('/')
+      b_list = file_b.to_s.split('/')
+
+      b_list[0..a_list.size - 1] == a_list
+    end
+
+    def eslint_d_available?
+      File.exist?(Rails.root.join('node_modules', '.bin', 'eslint_d'))
+    end
+
+    def generate_warnings(javascript)
+      relative_path = javascript.relative_path_from(Pathname.new(Dir.pwd))
+
+      warning_hashes(javascript).flat_map do |hash|
+        next if hash['errorCount'].zero?
+
+        hash['messages'].map do |message|
+          ESLintWebpacker::Warning.new(relative_path, message)
+        end
+      end.compact
+    end
+
+    def javascript_files
+      all_javascripts = webpacker_files.select do |asset|
+        JAVASCRIPT_EXTENSIONS.include?(asset.extname)
+      end
+
+      javascript_files = all_javascripts.select { |a| descendant?(@file, a) }
+
+      javascript_files.reject do |path|
+        path.to_s =~ /eslint.js|vendor|gems|min.js|editorial/
+      end
+    end
+
+    def normalize_infile(file)
+      # Remove beginning of asset path
+      file = file.to_s.gsub(%r{^app/javascript/}, '')
+
+      # Ensure path is absolute
+      file = Pathname.new("#{Dir.pwd}/app/javascript/#{file}")
+
+      return file if file.directory?
+      return file if file.extname.present?
+
+      # Make sure it has an extension
+      Pathname.new("#{file}.js")
+    end
+
+    def output_progress(warnings)
+      print case file_severity(warnings)
+            when :high
+              'H'.red
+            when :low
+              'L'.yellow
+            else
+              '.'.green
+            end
+    end
+
+    def warning_hashes(file_path)
+      command = eslint_d_available? ? 'eslint_d' : 'eslint'
+
+      JSON.parse(`./node_modules/.bin/#{command} --format json #{file_path}`)
+    end
+
+    def webpacker_files
+      Dir.glob(Rails.root.join('app', 'javascript', '**/*')).map do |path|
+        Pathname.new(path)
+      end
+    end
+
+    def file_severity(warnings)
+      return :none if warnings.blank?
+
+      warnings.map(&:severity).uniq.min
+    end
+  end
+end

data/lib/eslint-webpacker/text_formatter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/strip'
+require 'colorize'
+
+module ESLintWebpacker
+  class TextFormatter
+    def initialize(warnings)
+      @warnings = warnings
+    end
+
+    def format
+      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.green
+          when :high
+            message.yellow
+          else
+            raise 'BULLSHIT'
+          end
+        puts colorized_message
+      end
+
+      puts "#{@warnings.size} warning(s) found."
+    end
+
+    private
+
+    def max_length_of_attribute(attr_key)
+      @warnings.map { |warning| warning.send(attr_key).size }.max
+    end
+  end
+end

data/lib/eslint-webpacker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ESLintWebpacker
+  VERSION = '1.0.1'
+end

data/lib/eslint-webpacker/warning.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ESLintWebpacker
+  class Warning
+    attr_reader :filename, :line, :column, :node_type
+
+    SEVERITY = %i[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,25 @@
+# frozen_string_literal: true
+
+require 'eslint-webpacker'
+
+namespace :eslint do
+  def run_and_print_results(file)
+    puts 'Running Eslint...'
+    warnings = ESLintWebpacker::Runner.new(file).run
+
+    if warnings.empty?
+      puts 'All good! :)'.green
+      exit 0
+    else
+      formatter = ESLintWebpacker::TextFormatter.new(warnings)
+      formatter.format
+      exit 1
+    end
+  end
+
+  desc 'Run ESLint against the specified JavaScript file or the entire ' \
+       'project and report warnings'
+  task :run, [:filename] => :environment do |_, args|
+    run_and_print_results(args[:filename])
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: eslint-webpacker
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Guillaume Hain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+description: This gem is useful when added to the Rakefile in order to scan each of
+  your JavaScript files in a Ruby On Rails project using the webpacker gem.
+email:
+- zedtux@zedroot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eslint-webpacker.gemspec
+- lib/eslint-webpacker.rb
+- lib/eslint-webpacker/engine.rb
+- lib/eslint-webpacker/runner.rb
+- lib/eslint-webpacker/text_formatter.rb
+- lib/eslint-webpacker/version.rb
+- lib/eslint-webpacker/warning.rb
+- lib/tasks/eslint.rake
+homepage: https://gitlab.com/zedtux/eslint-webpacker
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/zedtux/eslint-webpacker
+  source_code_uri: https://gitlab.com/zedtux/eslint-webpacker
+  changelog_uri: https://gitlab.com/zedtux/eslint-webpacker-/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Runs eslint or eslint_d from Ruby
+test_files: []