browsh-org/browsh

Improve command line interface error feedback

Open

#196 opened on Sep 6, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (455 forks)batch import
bugenhancementhelp wanted

Repository metrics

Stars
 (15,996 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This issue could be solved by a junior Browsh developer. I hope it will encourage someone to get involved.

Currently when you simply start the Browsh binary without command line arguments, you get something like this:

./browsh_1.4.12_linux_amd64 exit status 1

The user doesn't know for what reason an error occurred.

Possible ways to improve this are to:

  • display the usage/help output, like --help
  • and/or to display an error message such as "Firefox binary not found and no path given. Use --firefox.path"

Contributor guide

Research direction
Add error handling and help output to the CLI. Check the main function where arguments are parsed and add a usage message if no arguments provided.
Tech stack
go
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80