pronto-shellcheck 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54767b522c275952880779ffb3a042961d0da8be
+  data.tar.gz: e3dfaf7c4e057e8d11c40b33bba9d921fb18c203
+SHA512:
+  metadata.gz: bd904cc1747db48028a388759a437c9d93ea4e306ac12a071a14ce8eec92a306d83ebb2e29476a00dd9a15120b09730b4827b518570a4e8c11b5031dbc4f5dc4
+  data.tar.gz: c641c4743fbf08fd56c2945147be17ff142345b2dae1ee483032a9cb1ce4d728fd554a40a20000dbb5880c3ea81832c76e5d32c5e846bc3276b0fd4fea416ac0

data/README.md

@@ -0,0 +1,17 @@
+# Pronto runner for ShellCheck
+
+[![Code Climate](https://codeclimate.com/github/pclalv/pronto-shellcheck.svg)](https://codeclimate.com/github/pclalv/pronto-shellcheck)
+[![Build Status](https://travis-ci.org/pclalv/pronto-shellcheck.svg?branch=master)](https://travis-ci.org/pclalv/pronto-shellcheck)
+
+
+Pronto runner for [ShellCheck](https://www.shellcheck.net). [What is Pronto?](https://github.com/mmozuras/pronto)
+
+## Prerequisites
+
+You'll need to install [shellcheck by yourself](https://github.com/koalaman/shellcheck#installing). If `shellcheck` is in your `PATH`, everything will simply work.
+
+## Configuration
+
+Pass any options you would pass to `shellcheck` with the [`SHELLCHECK_OPTS` environment variable](shellcheck_opts) to `pronto run`; e.g., `SHELLCHECK_OPTS='-x' pronto run`.
+
+[shellcheck_opts]: [https://github.com/koalaman/shellcheck/wiki/Integration#allow-passing-through-or-configuring-the-environment-variable-shellcheck_opts]

data/lib/pronto/shellcheck.rb

@@ -0,0 +1 @@
+require_relative 'shellcheck_runner'

data/lib/pronto/shellcheck_runner.rb

@@ -0,0 +1,92 @@
+require 'pronto'
+require 'shellwords'
+
+module Pronto
+  class ShellCheckRunner < Runner
+    extend Forwardable
+
+    EXTENSION = /^\..*sh$/
+    SHEBANG = %r{^#!/.*sh}
+    SHELLCHECK_PRONTO_LEVELS = {
+      'style' => :info,
+      'info' => :info,
+      'error' => :error,
+      'warning' => :warning
+    }.freeze
+
+    def_delegator self, :shellcheckable?
+
+    def run
+      return [] if !@patches || @patches.count.zero?
+
+      @patches
+        .select { |patch| patch.additions > 0 && shellcheckable?(patch.new_file_full_path) }
+        .reduce([]) { |results, patch| results.concat(inspect(patch)) }
+    end
+
+    class << self
+      def shellcheckable?(path)
+        path_has_extension?(path) || file_has_shebang?(path)
+      end
+
+      def path_has_extension?(path)
+        !(EXTENSION =~ path.extname).nil?
+      end
+
+      def file_has_shebang?(path)
+        shebang = File.readlines(path).first
+        !(SHEBANG =~ shebang).nil?
+      end
+    end
+
+    private :shellcheckable?
+    private
+
+      def repo_path
+        @repo_path ||= @patches.first.repo.path
+      end
+
+      def inspect(patch)
+        offences = run_shellcheck(patch).reject do |offence|
+          if offence['code'] == 1071
+            $stderr.puts "Skipped #{offence['file']}"
+            $stderr.puts "Reason: #{offence['message']} (SC#{offence['code']})"
+            true
+          else
+            false
+          end
+        end
+
+        offences
+          .reduce([]) do |messages, offence|
+            messages.concat(
+              patch
+                .added_lines
+                .select { |line| line.new_lineno == offence['line'] }
+                .map { |line| new_message(offence, line) }
+            )
+          end
+      end
+
+      def new_message(offence, line)
+        path = line.patch.delta.new_file[:path]
+        level = SHELLCHECK_PRONTO_LEVELS[offence['level']]
+        message = "SC#{offence['code']}: #{offence['message']}"
+
+        Message.new(path, line, level, message, nil, self.class)
+      end
+
+      def run_shellcheck(patch)
+        Dir.chdir(repo_path) do
+          escaped_file_path = Shellwords.escape(patch.new_file_full_path.to_s)
+          JSON.parse(
+            `shellcheck #{shellcheck_opts} -f json #{escaped_file_path}`
+          )
+        end
+      end
+
+      def shellcheck_opts
+        ENV['SHELLCHECK_OPTS']
+      end
+  end
+end

data/lib/pronto/shellcheck_version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module ShellCheckVersion
+    VERSION = '0.1.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: pronto-shellcheck
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Paul Alvarez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/pronto/shellcheck.rb
+- lib/pronto/shellcheck_runner.rb
+- lib/pronto/shellcheck_version.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- shellcheck (in PATH)
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Pronto runner for ShellCheck
+test_files: []