class Prism::ParseResult::Errors

An object to represent the set of errors on a parse result. This object can be used to format the errors in a human-readable way.

Attributes

parse_result[R]

The parse result that contains the errors.

Public Class Methods

new(parse_result) click to toggle source

Initialize a new set of errors from the given parse result.

# File lib/prism/parse_result/errors.rb, line 14
def initialize(parse_result)
  @parse_result = parse_result
end

Public Instance Methods

format() click to toggle source

Formats the errors in a human-readable way and return them as a string.

# File lib/prism/parse_result/errors.rb, line 19
def format
  error_lines = {}
  parse_result.errors.each do |error|
    location = error.location
    (location.start_line..location.end_line).each do |line|
      error_lines[line] ||= []
      error_lines[line] << error
    end
  end

  source_lines = parse_result.source.source.lines
  source_lines << "" if error_lines.key?(source_lines.size + 1)

  io = StringIO.new
  source_lines.each.with_index(1) do |line, line_number|
    io.puts(line)

    (error_lines.delete(line_number) || []).each do |error|
      location = error.location

      case line_number
      when location.start_line
        io.print(" " * location.start_column + "^")

        if location.start_line == location.end_line
          if location.start_column != location.end_column
            io.print("~" * (location.end_column - location.start_column - 1))
          end

          io.puts(" " + error.message)
        else
          io.puts("~" * (line.bytesize - location.start_column))
        end
      when location.end_line
        io.puts("~" * location.end_column + " " + error.message)
      else
        io.puts("~" * line.bytesize)
      end
    end
  end

  io.puts
  io.string
end