danger-shellcheck 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 101ff4668cb3af350a01002ccfef299839365e5a
+  data.tar.gz: ba5dcaa7805a200520137008a709e79019c88ed7
+SHA512:
+  metadata.gz: 687e898dc3c65110c85a9c5e9f4280cb755416f54a0ab79028224993701929363ba435e40c94ca20a000d50cfa8b45d8c8b35a094b81b6a9ab56d0f6686532e0
+  data.tar.gz: 0982463bc8e0e37d7eefbe147b59c00a79eea03a1b07a3a4cb2b0aea9df6dac61327ee66e97328571c22a9c84057a2513bfcf79cffb40c2ae858b0b4fb36b472

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,88 @@
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# HoundCI doesn't like this rule
+Style/DotPosition:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 320
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Enabled: false
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/BlockLength:
+  Max: 50
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+sudo: false
+
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-shellcheck.gemspec
+gemspec
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: .
+  specs:
+    danger-shellcheck (1.0.0)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ast (2.3.0)
+    claide (1.0.1)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.1)
+    colored (1.2)
+    colored2 (3.1.2)
+    cork (0.2.0)
+      colored (~> 1.2)
+    coveralls (0.8.19)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    danger (4.3.2)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      kramdown (~> 1.5)
+      octokit (~> 4.2)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.12.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    git (1.3.0)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    json (2.0.3)
+    kramdown (1.13.2)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.11)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.6.2)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (2.0.5)
+    rainbow (2.2.1)
+    rake (10.5.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    shellany (0.0.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.5.0)
+      tins (~> 1.0)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
+    thor (0.19.4)
+    tins (1.13.2)
+    unicode-display_width (1.1.3)
+    yard (0.9.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  coveralls
+  danger-shellcheck!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.41)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.13.5

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Intrepid Pursuits LLC
+
+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,45 @@
+# danger-shellcheck
+
+[![Build Status](https://travis-ci.org/IntrepidPursuits/danger-shellcheck.svg?branch=master)](https://travis-ci.org/IntrepidPursuits/danger-shellcheck)
+[![Coverage Status](https://coveralls.io/repos/github/IntrepidPursuits/danger-shellcheck/badge.svg?branch=master)](https://coveralls.io/github/IntrepidPursuits/danger-shellcheck?branch=master)
+![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
+
+A [Danger](http://danger.systems/) plugin that shows the static analysis output generated by [ShellCheck](https://github.com/koalaman/shellcheck).
+
+To use this plugin, you need to generate a JSON file using [ShellCheck](https://github.com/koalaman/shellcheck) for this plugin to read.
+
+## Installation
+
+    $ gem install danger-shellcheck
+
+## Usage
+
+Somewhere in your build process, call ShellCheck using the JSON output flag.
+
+    shellcheck -f json myscript myotherscript > shellcheck.json
+
+An easy way to have shellcheck look at all of your .sh files is:
+
+    shellcheck -f json **/*.sh > shellcheck.json
+
+At a minimum, add this line to your `Dangerfile`:
+
+    shellcheck.report 'shellcheck.json'
+
+You may also use optional specifiers to ignore files, or set the project root.
+
+    # Set a different project root
+    shellcheck.project_root = 'MyProject/NewRoot/'
+
+
+## License
+danger-shellcheck is released under the MIT license. See [LICENSE](https://github.com/IntrepidPursuits/danger-shellcheck/blob/master/LICENSE) for details.
+
+## Contributing
+
+1. Fork this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.
+6. Create a Pull Request for us to review

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-shellcheck.gemspec

@@ -0,0 +1,54 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shellcheck/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-shellcheck'
+  spec.version       = Shellcheck::VERSION
+  spec.authors       = ['David Brooks']
+  spec.email         = ['dbrooks@intrepid.io']
+  spec.description   = 'Show formatted static analysis report in your PRs for shell scripts'
+  spec.summary       = 'A [Danger](https://danger.systems) plugin that shows ' \
+                        'warnings and errors generated from the ShellCheck ' \
+                        'static analysis tool for shell scripts.'
+  spec.homepage      = 'https://github.com/IntrepidPursuits/danger-shellcheck'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop", "~> 0.41"
+  spec.add_development_dependency "yard", "~> 0.8"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # Use coveralls
+  spec.add_development_dependency 'coveralls', '0.8.19'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'shellcheck/plugin'

data/lib/danger_shellcheck.rb

@@ -0,0 +1 @@
+require 'shellcheck/gem_version'

data/lib/shellcheck/gem_version.rb

@@ -0,0 +1,3 @@
+module Shellcheck
+  VERSION = '1.0.0'.freeze
+end

data/lib/shellcheck/plugin.rb

@@ -0,0 +1,99 @@
+require 'set'
+
+module Danger
+  # Shows the warnings and suggestions for shell scripts generated from ShellCheck.
+  # You need [ShellCheck](https://github.com/koalaman/shellcheck) installed and generating a json file
+  # to use this plugin.
+  #
+  # @example Showing summary
+  #
+  #     shellcheck -f json myscript > shellcheck.json
+  #     shellcheck.report 'shellcheck.json'
+  #
+  # @see IntrepidPursuits/danger-shellcheck
+  # @tags bash, sh, lint, syntax, format, analysis
+  #
+  class DangerShellcheck < Plugin
+    # The project root, which will be used to make the paths relative.
+    # Defaults to 'pwd'.
+    # @return   [String] project_root value
+    attr_accessor :project_root
+
+    # Defines if the test summary will be sticky or not
+    # Defaults to 'false'
+    # @return   [Boolean] sticky
+    attr_accessor :sticky_summary
+
+    def project_root
+      root = @project_root || Dir.pwd
+      root += '/' unless root.end_with? '/'
+      root
+    end
+
+    def sticky_summary
+      @sticky_summary || false
+    end
+
+    # Reads a file with JSON ShellCheck summary and reports it.
+    #
+    # @param    [String] file_path Path for ShellCheck summary in JSON format.
+    # @return   [void]
+    def report(file_path)
+      raise 'ShellCheck summary file not found' unless File.file?(file_path)
+      shellcheck_summary = JSON.parse(File.read(file_path), symbolize_names: true)
+      run_summary(shellcheck_summary)
+    end
+
+    private
+
+    def run_summary(shellcheck_summary)
+      @files = Set.new
+      @error_count = 0
+      @warning_count = 0
+      @info_count = 0
+      @style_count = 0
+
+      # Parse the file violations
+      parse_files(shellcheck_summary)
+
+      # Output the ShellCheck summary
+      message(summary_message, sticky: sticky_summary)
+    end
+
+    def summary_message
+      "ShellCheck Summary: Analyzed #{@files.size} files. Found #{@error_count} errors. #{@warning_count} Warnings, #{@info_count} Info and #{@style_count} Style Violations."
+    end
+
+    # A method that takes the ShellCheck summary and parses any violations found
+    def parse_files(shellcheck_summary)
+      shellcheck_summary.each do |element|
+        file = element[:file]
+        @files.add(file)
+        level = element[:level]
+
+        message = format_violation(file, element)
+
+        if level == 'error'
+          @error_count += 1
+          fail(message, sticky: false)
+        else
+          if level == 'warning'
+            @warning_count += 1
+          elsif level == 'info'
+            @info_count += 1
+          else
+            @style_count += 1
+          end
+          warn(message, sticky: false)
+        end
+      end
+    end
+
+    # A method that returns a formatted string for a violation
+    # @return   String
+    #
+    def format_violation(file, violation)
+      "#{file}: #L#{violation[:line]} -> #{violation[:code]} - #{violation[:message]}"
+    end
+  end
+end

data/spec/shellcheck.json

@@ -0,0 +1,118 @@
+[{
+    "file": "maintenance/clean_jenkins_logs.sh",
+    "line": 8,
+    "endLine": 8,
+    "column": 44,
+    "endColumn": 44,
+    "level": "warning",
+    "code": 2061,
+    "message": "Quote the parameter to -name so the shell won't interpret it."
+}, {
+    "file": "maintenance/clean_jenkins_logs.sh",
+    "line": 8,
+    "endLine": 8,
+    "column": 44,
+    "endColumn": 44,
+    "level": "info",
+    "code": 2035,
+    "message": "Use ./*glob* or -- *glob* so names with dashes won't become options."
+}, {
+    "file": "ios/run_pull_request_tests.sh",
+    "line": 7,
+    "endLine": 7,
+    "column": 6,
+    "endColumn": 6,
+    "level": "error",
+    "code": 2086,
+    "message": "Double quote to prevent globbing and word splitting."
+}, {
+    "file": "ios/run_pull_request_tests.sh",
+    "line": 7,
+    "endLine": 7,
+    "column": 32,
+    "endColumn": 32,
+    "level": "info",
+    "code": 2086,
+    "message": "Double quote to prevent globbing and word splitting."
+}, {
+    "file": "ios/run_pull_request_tests.sh",
+    "line": 27,
+    "endLine": 27,
+    "column": 1,
+    "endColumn": 1,
+    "level": "error",
+    "code": 2086,
+    "message": "Double quote to prevent globbing and word splitting."
+}, {
+    "file": "iOS-Core/unittest.sh",
+    "line": 64,
+    "endLine": 64,
+    "column": 24,
+    "endColumn": 24,
+    "level": "info",
+    "code": 2059,
+    "message": "Don't use variables in the printf format string. Use printf \"..%s..\" \"$foo\"."
+}, {
+    "file": "iOS-Core/unittest.sh",
+    "line": 73,
+    "endLine": 73,
+    "column": 24,
+    "endColumn": 24,
+    "level": "info",
+    "code": 2059,
+    "message": "Don't use variables in the printf format string. Use printf \"..%s..\" \"$foo\"."
+}, {
+    "file": "iOS-Core/simulator.sh",
+    "line": 49,
+    "endLine": 49,
+    "column": 24,
+    "endColumn": 24,
+    "level": "info",
+    "code": 2059,
+    "message": "Don't use variables in the printf format string. Use printf \"..%s..\" \"$foo\"."
+}, {
+    "file": "iOS-Core/rebundle.sh",
+    "line": 55,
+    "endLine": 55,
+    "column": 24,
+    "endColumn": 24,
+    "level": "info",
+    "code": 2059,
+    "message": "Don't use variables in the printf format string. Use printf \"..%s..\" \"$foo\"."
+}, {
+    "file": "iOS-Core/rebundle.sh",
+    "line": 64,
+    "endLine": 64,
+    "column": 24,
+    "endColumn": 24,
+    "level": "info",
+    "code": 2059,
+    "message": "Don't use variables in the printf format string. Use printf \"..%s..\" \"$foo\"."
+}, {
+    "file": "iOS-Core/rebundle.sh",
+    "line": 73,
+    "endLine": 73,
+    "column": 24,
+    "endColumn": 24,
+    "level": "style",
+    "code": 2059,
+    "message": "Don't use variables in the printf format string. Use printf \"..%s..\" \"$foo\"."
+}, {
+    "file": "iOS-Core/rebundle.sh",
+    "line": 103,
+    "endLine": 103,
+    "column": 12,
+    "endColumn": 12,
+    "level": "error",
+    "code": 2059,
+    "message": "Don't use variables in the printf format string. Use printf \"..%s..\" \"$foo\"."
+}, {
+    "file": "iOS-Core/rebundle.sh",
+    "line": 108,
+    "endLine": 108,
+    "column": 15,
+    "endColumn": 15,
+    "level": "warning",
+    "code": 2153,
+    "message": "Possible misspelling: WORKSPACE may not be assigned, but workspace is."
+}]

data/spec/shellcheck_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Danger::DangerShellcheck do
+    it 'should be a plugin' do
+      expect(Danger::DangerShellcheck.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.shellcheck
+      end
+
+      it 'Parses JSON with errors, warnings, info and style violations' do
+        file_path = File.expand_path('../shellcheck.json', __FILE__)
+        @my_plugin.report(file_path)
+        expect(@dangerfile.status_report[:errors].length).to be == 3
+        expect(@dangerfile.status_report[:warnings].length).to be == 10
+        expect(@dangerfile.status_report[:markdowns]).to eq([])
+      end
+
+      it 'Displays a summary message' do
+        file_path = File.expand_path('../shellcheck.json', __FILE__)
+        @my_plugin.report(file_path)
+        expect(@dangerfile.status_report[:messages]).to eq(['ShellCheck Summary: Analyzed 5 files. Found 3 errors. 2 Warnings, 7 Info and 1 Style Violations.'])
+      end
+
+      it 'Displays a properly formatted error message' do
+        file_path = File.expand_path('../shellcheck.json', __FILE__)
+        @my_plugin.report(file_path)
+        expect(@dangerfile.status_report[:errors][0]).to eq('ios/run_pull_request_tests.sh: #L7 -> 2086 - Double quote to prevent globbing and word splitting.')
+      end
+
+      it 'Displays a properly formatted warning message' do
+        file_path = File.expand_path('../shellcheck.json', __FILE__)
+        @my_plugin.report(file_path)
+        expect(@dangerfile.status_report[:warnings][0]).to eq('maintenance/clean_jenkins_logs.sh: #L8 -> 2061 - Quote the parameter to -name so the shell won\'t interpret it.')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+require 'coveralls'
+Coveralls.wear!
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+require 'danger_plugin'
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: danger-shellcheck
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Brooks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.19
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Show formatted static analysis report in your PRs for shell scripts
+email:
+- dbrooks@intrepid.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- danger-shellcheck.gemspec
+- lib/danger_plugin.rb
+- lib/danger_shellcheck.rb
+- lib/shellcheck/gem_version.rb
+- lib/shellcheck/plugin.rb
+- spec/shellcheck.json
+- spec/shellcheck_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/IntrepidPursuits/danger-shellcheck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: A [Danger](https://danger.systems) plugin that shows warnings and errors
+  generated from the ShellCheck static analysis tool for shell scripts.
+test_files:
+- spec/shellcheck.json
+- spec/shellcheck_spec.rb
+- spec/spec_helper.rb