browsh-org/browsh

Debugging guide

Open

#228 opened on Oct 8, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (15,996 stars) (455 forks)batch import
help wantedquestiontty-mode

Description

We have guides for setting up a build system on Mac, Windows and Linux.

But what about debugging?

I'm especially interested in the best way to debug the tty frontend.

It's possible to debug go binaries with a special go debugger called delve and also the well-known gdb.

Delve is supposed to have better support for go's data structures and features, since it was developed specifically for go.

I tried to run browsh in delve, but my issue was that the screen was never rendered to the tty, although browsh was running.

If someone understands how to initiate a debug session with either delve or gdb, where you can use browsh normally, and also get backtraces and step through code, I would be very pleased to read your instructions for it.

Another interesting topic is the debugging of the webextension. I didn't have much luck with Firefox's debugging tools. Maybe someone can share pro tips for that. I believe Chrome's debugging tools to be of better quality, which would be an additional reason for porting browsh to Chrome.

Contributor guide

Tech stack
gojavascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go basicsDebugging with delve or gdb
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The request is to create a debugging guide for browsh's tty frontend and webextension. Look into using delve or gdb for Go debugging, and Firefox/Chrome developer tools for the webextension. Examine existing build guides for structure and identify relevant code files in the repository (e.g., main.go, webextension files). Document steps to set up a debug session and inspect runtime behavior.