Contents

# frozen_string_literal: true

require 'pre-commit/checks/shell'
require_relative '../message/extractor'
require_relative '../message/formatter'
require_relative '../support/path'

module PreCommit
  module Checks
    ##
    # Plugin implementation for pre-commit gem
    #
    # It provides a java checkstyle validation using checkstyle.jar
    # for details see:
    # lib/pre_commit/support/checkstyle
    class Checkstyle < Shell
      ##
      # Function called after pre-commit execution
      # this method receive the +staged_files+ from git
      #
      # @param [String] Standard git ouput with staged files
      def call(staged_files)
        staged_files = staged_files.grep(/\.java$/)
        return if staged_files.empty?

        output = execute(args(staged_files))
        format(extract(output))
      end

      def self.description
        'Runs Checkstyle linter for java code.'
      end

      private

      def args(staged_files)
        [
          'java',
          checkstyle_jar,
          configuration_file,
          staged_files,
          output_format
        ]
      end

      def checkstyle_jar
        ['-jar', Support::Path.relative_to('checkstyle-6.11-all.jar')]
      end

      def configuration_file
        config_file ? ['-c', config_file] : []
      end

      def output_format
        ['-f', 'xml']
      end

      def alternate_config_file
        Support::Path.relative_to('google_checks.xml')
      end

      def format(errors)
        @formatter ||= PreCommit::Message::Formatter.new
        @formatter.format errors
      end

      def extract(data)
        @extractor ||= PreCommit::Message::Extractor.new
        @extractor.extract data
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
java-checkstyle-precommit-1.0.0	lib/plugins/pre_commit/checks/checkstyle.rb