ruby / ruby/reline

Support `Reline.dump` to help investigate issues

Open
#555 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Ruby
Stars
311
Forks
99
Avg merge
6d 4h
Merged PRs (30d)
1

Description

Description

When an input issue happens, users could type Reline.dump, and it will

  1. Collect important states (TBD)
  2. Serialises it to an easily-comparable format (json or yaml?)
  3. Dump the data to a pre-defined file path (so users won't need to copy it from a messed up output)

This will be similar to irb_info in IRB that should help us collect helpful information before we look into the issue, and speed up the investigation.

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 examining IRB's irb_info, which the issue identifies as a similar feature. Define which Reline states to collect, choose JSON or YAML, and determine the predefined output path; the work is done when Reline.dump collects and serializes useful input state to that path.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.