browsh-org/browsh

Configurable color/monochrome mode from CLI and config file

Open

#187 opened on Aug 22, 2018

View on GitHub
 (11 comments) (0 reactions) (0 assignees)JavaScript (15,996 stars) (455 forks)batch import
enhancementhelp wantedtty-mode

Description

This is a job for a junior browsh developer and should be possible to solve for anyone who has the development environment setup.

Currently the monochrome mode can only be activated by pressing ALT+m.

The default should be configurable in the config.

And it should be possible to select the color mode from the command line.

Use cases:

  • For testing purposes I was using ansi-term inside emacs today and unfortunately the key combination ALT+m isn't forwarded correctly to browsh.
  • Prefering monochrome mode to save bandwidth

Contributor guide

Tech stack
javascriptnodejs
Domain
cliperformance
Issue type
feature
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.
clear
Prerequisites
Node.js environment setupFamiliarity with CLI argument parsingUnderstanding of config file handling in the project
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requires modifying the existing config file handling and CLI argument parser. Look for where the monochrome mode is currently toggled (likely a keyboard handler) and add a corresponding config key and CLI flag. The existing test suite might provide hints on how to test the new functionality. Consider investigating the project's configuration file structure and CLI argument parsing library (e.g., yargs or commander).