pronto-eslint_npm 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70ee17c24d2de82f6324109da2f7f020249bd060
-  data.tar.gz: 183e13d563090e0effde44519400af9139debe46
+  metadata.gz: 606c381f93b0e8785e967394f259303420e7e517
+  data.tar.gz: 883b1c12ef76bd5bc68144e2f06fa5978fce6eb2
 SHA512:
-  metadata.gz: 7b4a13dce0e0181a1ec5bfc88d9c52c72e5bd181fa0df719dcaa2c2e10202aac3c047c3ce983a9a51a36ebb8156076109e7261a0e8ae1a27a4db8273b1621663
-  data.tar.gz: acd24953accc803f2606fbb11baa2636840176cba344d6c945adb9887aeeb6907592373a6f0346a0779282f6fa9555693953f26774aad5e4961f8dcc36499980
+  metadata.gz: 3074674affe7f46e56915fbaf62f4400f8ed578f890598dafa789ee8822c5898ea22c289857b5c21e70e3d5691a96053d2719c144fa6e956b621448596b4079b
+  data.tar.gz: ed15b03ea2848117e954cabffe2c8fa2ad55454bff0145afed1859fa8af0b785b9d4ea0df262d236c90af413d9249b9e1663c1b905fd36f6ad05b628a44f09ac

data/README.md

@@ -7,19 +7,39 @@
 
 Pronto runner for [ESlint](http://eslint.org), pluggable linting utility for JavaScript and JSX. [What is Pronto?](https://github.com/mmozuras/pronto)
 
-Uses system wide installed eslint in contrast to [pronto-eslint][pronto-eslint].
+Uses official eslint executable installed by `npm` in contrast to [pronto-eslint][pronto-eslint].
 
 [pronto-eslint]: https://github.com/mmozuras/pronto-eslint
 
 ## Prerequisites
 
-You'll need to install [eslint by yourself with npm][eslint-install].
+You'll need to install [eslint by yourself with npm][eslint-install]. If `eslint` is in your `PATH`, everything will simply work, otherwise you have to provide pronto-eslint-npm your custom executable path (see [below](#configuration-of-eslintnpm)).
 
 [eslint-install]: http://eslint.org/docs/user-guide/getting-started
 
-## Configuration
+## Configuration of ESLint
 
-Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint.
+Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint-npm.
 
 [eslintrc]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats
+
 [eslintignore]: http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories
+
+## Configuration of ESLintNPM
+
+pronto-eslint-npm can be configured by placing a `.pronto_eslint_npm.yml` inside the directory where pronto is run.
+
+Following options are available:
+
+| Option            | Meaning                                                                                  | Default                             |
+| ----------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- |
+| eslint_executable | ESLint executable to call.                                                               | `eslint` (calls `eslint` in `PATH`) |
+| files_to_lint     | What files to lint. Absolute path of offending file will be matched against this Regexp. | `(\.js|\.es6)$`                     |
+
+Example configuration to call custom eslint executable and only lint files ending with `.my_custom_extension`:
+
+```yaml
+# .pronto_eslint_npm.yaml
+eslint_executable: '/my/custom/node/path/.bin/eslint'
+files_to_lint: '\.my_custom_extension$'
+```

data/lib/pronto/eslint_npm.rb

@@ -1,19 +1,55 @@
 require 'pronto'
+require 'shellwords'
 
 module Pronto
   class ESLintNpm < Runner
+    CONFIG_FILE = '.pronto_eslint_npm.yml'.freeze
+    CONFIG_KEYS = %w(eslint_executable files_to_lint).freeze
+
+    attr_writer :eslint_executable
+
+    def eslint_executable
+      @eslint_executable || 'eslint'.freeze
+    end
+
+    def files_to_lint
+      @files_to_lint || /(\.js|\.es6)$/
+    end
+
+    def files_to_lint=(regexp)
+      @files_to_lint = regexp.is_a?(Regexp) && regexp || Regexp.new(regexp)
+    end
+
+    def read_config
+      config_file = File.join(repo_path, CONFIG_FILE)
+      return unless File.exist?(config_file)
+      config = YAML.load_file(config_file)
+
+      CONFIG_KEYS.each do |config_key|
+        next unless config[config_key]
+        send("#{config_key}=", config[config_key])
+      end
+    end
+
     def run
-      return [] unless @patches
+      return [] if !@patches || @patches.count.zero?
+
+      read_config
 
-      @patches.select { |patch| patch.additions > 0 }
+      @patches
+        .select { |patch| patch.additions > 0 }
         .select { |patch| js_file?(patch.new_file_full_path) }
         .map { |patch| inspect(patch) }
         .flatten.compact
     end
 
-    def inspect(patch)
+    private
+
+    def repo_path
       @_repo_path ||= @patches.first.repo.path
+    end
 
+    def inspect(patch)
       offences = run_eslint(patch)
       clean_up_eslint_output(offences)
         .map do |offence|
@@ -24,8 +60,6 @@ module Pronto
         end
     end
 
-    private
-
     def new_message(offence, line)
       path = line.patch.delta.new_file[:path]
       level = :warning
@@ -34,18 +68,18 @@ module Pronto
     end
 
     def js_file?(path)
-      %w(.js .es6 .js.es6).include?(File.extname(path))
+      files_to_lint =~ path.to_s
     end
 
     def run_eslint(patch)
-      Dir.chdir(@_repo_path) do
+      Dir.chdir(repo_path) do
+        escaped_file_path = Shellwords.escape(patch.new_file_full_path.to_s)
         JSON.parse(
-          `eslint #{Shellwords.escape(patch.new_file_full_path.to_s)} -f json`
+          `#{eslint_executable} #{escaped_file_path} -f json`
         )
       end
     end
 
-    # rubocop:disable Metrics/LineLength
     def clean_up_eslint_output(output)
       # 1. Filter out offences without a warning or error
       # 2. Get the messages for that file

data/lib/pronto/eslint_npm/version.rb

@@ -1,5 +1,5 @@
 module Pronto
   module ESLintNpmVersion
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.7.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pronto-eslint_npm
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Markus Doits
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 description: 
 email: markus.doits@gmail.com
 executables: []