Sha256: 250296d6fd1da0d0de86b3416fb49d3e16180c27faee0878e98472c271779876

Contents?: true

Size: 1.24 KB

Versions: 10

Compression:

Stored size: 1.24 KB

Contents

module Overcommit::Hook::PreCommit
  # Runs `phpcs` against any modified PHP files.
  class PhpCs < Base
    # Parse `phpcs` csv mode output
    MESSAGE_REGEX = /^\"(?<file>.+)\",(?<line>\d+),\d+,(?<type>.+),\"(?<msg>.+)\"/
    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
      'error'.include?(type) ? :error : :warning
    end

    def run
      messages = []

      applicable_files.each do |file|
        result = execute(command, args: [file])
        if result.status
          rows = result.stdout.split("\n")

          # Discard the csv header
          rows.shift

          # Push each of the errors in the particular file into the array
          rows.map do |row|
            messages << row
          end
        end
      end

      return :pass if messages.empty?

      parse_messages(messages)
    end

    # Transform the CSV output into a tidy human readable message
    def parse_messages(messages)
      output = []

      messages.map do |message|
        message.scan(MESSAGE_REGEX).map do |file, line, type, msg|
          type = MESSAGE_TYPE_CATEGORIZER.call(type)
          text = " #{file}:#{line}\n  #{msg}"
          output << Overcommit::Hook::Message.new(type, file, line.to_i, text)
        end
      end

      output
    end
  end
end

Version data entries

10 entries across 8 versions & 2 rubygems

Version Path
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/overcommit-0.46.0/lib/overcommit/hook/pre_commit/php_cs.rb
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/overcommit-0.46.0/lib/overcommit/hook/pre_commit/php_cs.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/overcommit-0.46.0/lib/overcommit/hook/pre_commit/php_cs.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/overcommit-0.46.0/lib/overcommit/hook/pre_commit/php_cs.rb
overcommit-0.46.0 lib/overcommit/hook/pre_commit/php_cs.rb
overcommit-0.45.0 lib/overcommit/hook/pre_commit/php_cs.rb
overcommit-0.44.0 lib/overcommit/hook/pre_commit/php_cs.rb
overcommit-0.43.0 lib/overcommit/hook/pre_commit/php_cs.rb
overcommit-0.42.0 lib/overcommit/hook/pre_commit/php_cs.rb
overcommit-0.41.0 lib/overcommit/hook/pre_commit/php_cs.rb