ruby / ruby/error_highlight

Remove custom formatter

Open
#15 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
155
Forks
37
Avg merge
4d 2h
Merged PRs (30d)
1

Description

https://github.com/ruby/error_highlight/blob/9fbaa8ab7c09257320afb39ae4619251362291b1/lib/error_highlight/formatter.rb#L16

I believe it would be prudent at least for the first stable release of this gem, to remove the ErrorHighlight#formatter override.

I believe it will be very hard to use in practice and adds unnecessary public interface and complexity.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading lib/error_highlight/formatter.rb at the referenced formatter implementation and inspect how ErrorHighlight#formatter is exposed. The change is complete when the custom formatter override and its public interface are removed without leaving the gem's formatter behavior inconsistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.