From: "ioquatix (Samuel Williams)" <noreply@...>
Date: 2021-11-10T11:58:48+00:00
Subject: [ruby-core:106010] [Ruby master Bug#18296] Custom exception formatting should override `Exception#full_message`.

Issue #18296 has been updated by ioquatix (Samuel Williams).


Also given how this works, I believe we should remove `ErrorHighlight.formatter` from the public interface. https://github.com/ruby/error_highlight/issues/15

----------------------------------------
Bug #18296: Custom exception formatting should override `Exception#full_message`.
https://bugs.ruby-lang.org/issues/18296#change-94563

* Author: ioquatix (Samuel Williams)
* Status: Open
* Priority: Normal
* Backport: 2.6: UNKNOWN, 2.7: UNKNOWN, 3.0: UNKNOWN
----------------------------------------
After discussing with @eregon, we came to the conclusion that the current implementation of `did_you_mean` and `error_highlighter` could avoid many issues by using `Exception#full_message`.

We propose to introduce a more nuanced interface:

```ruby
class Exception
  def full_message(highlight: bool, order: [:top or :bottom], **options)
    # ...
  end
end

module DidYouMean
  class Formatter
    def full_message(highlight:, did_you_mean: true, **options)
      buffer = super(highlight: highlight, **options).dup
      buffer << "extra stuff"
    end
  end
end

module ErrorHighlight
  class Formatter
    def full_message(highlight:, error_highlight: true, **options)
      # same as above
    end
  end
end
```



-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:ruby-core-request@ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>