pronto-hlint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 441848a65b4876773f2995a8d59b9cb9768c1b51991ab0d90d706f80970b94b0
+  data.tar.gz: 86bd2cad174dd7aa95ab930711adacb060902a52c7130dd72830354445bd3744
+SHA512:
+  metadata.gz: 29b217d89d38d7e8397777523c90459161563cdc2ea5b864a8a1d378bdbbb4694000e8548389a2c938f553cef84e49aa759342cfb56484cf7a469ec9e93dd868
+  data.tar.gz: 3b49d909bae096fbef0da5d1a9237879e2e914ce50b7007cd7471b76e6a05832d04aed010ee909029a2bd66d3021290ddd8af8570cfbb40db62ecba512bbd877

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019 Fretlink
+
+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,39 @@
+# Pronto runner for Hlint
+
+[![Build Status](https://travis-ci.org/fretlink/pronto-hlint.svg?branch=master)](https://travis-ci.org/fretlink/pronto-hlint)
+[![Gem Version](https://badge.fury.io/rb/pronto-hlint.svg)](http://badge.fury.io/rb/pronto-hlint)
+
+Pronto runner for [Hlint](https://hackage.haskell.org/package/hlint), pluggable linting utility for Haskell. [What is Pronto?](https://github.com/mmozuras/pronto)
+
+## Prerequisites
+
+You'll need to install [hlint by yourself with cabal or stack][hlint-install]. If `hlint` is in your `PATH`, everything will simply work, otherwise you have to provide pronto-hlint your custom executable path (see [below](#configuration-of-hlint)).
+
+[hlint-install]: https://github.com/ndmitchell/hlint#installing-and-running-hlint
+
+## Configuration of Hlint
+
+Configuring Hlint via [.hlint.yaml][.hlint.yaml] will work just fine with pronto-hlint.
+
+[.hlint.yaml]: https://github.com/ndmitchell/hlint#customizing-the-hints
+
+## Configuration of Pronto-Hlint
+
+pronto-hlint can be configured by placing a `.pronto_hlint.yml` inside the directory where pronto will run.
+
+Following options are available:
+
+| Option            | Meaning                                                                                  | Default                             |
+| ----------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- |
+| hlint_executable  | Hlint executable to call.                                                                | `hlint` (calls `hlint` in `PATH`)   |
+| files_to_lint     | What files to lint. Absolute path of offending file will be matched against this Regexp. | `(\.hs)$`                           |
+| cmd_line_opts     | Command line options to pass to hlint when running                                       | ``                                  |
+
+Example configuration to call custom hlint executable and only lint files ending with `.my_custom_extension`:
+
+```yaml
+# .pronto_hlint.yml
+hlint_executable: '/my/custom/path/.bin/hlint'
+files_to_lint: '\.my_custom_extension$'
+cmd_line_opts: '-j $(nproc) --typecheck'
+```

data/lib/pronto/hlint.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'pronto/hlint/runner'
+
+module Pronto
+  module Hlint
+  end
+end

data/lib/pronto/hlint/runner.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require 'shellwords'
+
+module Pronto
+  module Hlint
+    class Runner < Pronto::Runner
+      CONFIG_FILE = '.pronto_hlint.yml'.freeze
+      CONFIG_KEYS = %w[hlint_executable files_to_lint cmd_line_opts].freeze
+
+      attr_writer :hlint_executable, :cmd_line_opts
+
+      def hlint_executable
+        @hlint_executable || 'hlint'
+      end
+
+      def files_to_lint
+        @files_to_lint || /(\.hs)$/
+      end
+
+      def cmd_line_opts
+        @cmd_line_opts || ''
+      end
+
+      def files_to_lint=(regexp)
+        @files_to_lint = regexp.is_a?(Regexp) && regexp || Regexp.new(regexp)
+      end
+
+      def config_options
+        @config_options ||=
+          begin
+            config_file = File.join(repo_path, CONFIG_FILE)
+            File.exist?(config_file) && YAML.load_file(config_file) || {}
+          end
+      end
+
+      def read_config
+        config_options.each do |key, val|
+          next unless CONFIG_KEYS.include?(key.to_s)
+          send("#{key}=", val)
+        end
+      end
+
+      def run
+        return [] if !@patches || @patches.count.zero?
+
+        read_config
+
+        @patches
+          .select { |patch| patch.additions > 0 }
+          .select { |patch| hs_file?(patch.new_file_full_path) }
+          .map { |patch| inspect(patch) }
+          .flatten.compact
+      end
+
+      private
+
+      def repo_path
+        @repo_path ||= @patches.first.repo.path
+      end
+
+      def inspect(patch)
+        offences = run_hlint(patch)
+        offences
+          .map do |offence|
+          patch
+            .added_lines
+            .select { |line| (offence['startLine']..offence['endLine']).include?(line.new_lineno) }
+            .map { |line| new_message(offence, line) }
+        end
+      end
+
+      def new_message(offence, line)
+        path  = line.patch.delta.new_file[:path]
+        level = hlint_severity_to_pronto_level(offence['severity']) || :warning
+
+        text = <<~EOF
+        #{offence['severity']} offence detected by Hlint. Hint is: `#{offence['hint']}`.
+
+        Consider changing the code from
+        ```
+        #{offence['from']}
+        ```
+        to
+        ```
+        #{offence['to']}
+        ```
+      EOF
+
+        Message.new(path, line, level, text, nil, self.class)
+      end
+
+      def hlint_severity_to_pronto_level(severity)
+        case severity
+        when "Error"
+          :error
+        when "Warning"
+          :warning
+        when "Suggestion"
+          :info
+        end
+      end
+
+      def hs_file?(path)
+        files_to_lint =~ path.to_s
+      end
+
+      def run_hlint(patch)
+        Dir.chdir(repo_path) do
+          JSON.parse `#{hlint_command_line(patch.new_file_full_path.to_s)}`
+        end
+      end
+
+      def hlint_command_line(path)
+        "#{hlint_executable} #{cmd_line_opts} #{Shellwords.escape(path)} --json"
+      end
+    end
+  end
+end

data/lib/pronto/hlint/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pronto
+  module Hlint
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: pronto-hlint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Bonaud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email: paul.bonaud@fretlink.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/pronto/hlint.rb
+- lib/pronto/hlint/runner.rb
+- lib/pronto/hlint/version.rb
+homepage: https://github.com/fretlink/pronto-hlint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- hlint (in PATH)
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Pronto runner for Hlint, pluggable linting utility for Haskell
+test_files: []