gbdev / gbdev/rgbds

Make CLI flags more consistent

Open
#2,042 0 comments 0 reactions 0 assignees View on GitHub
breaking enhancement rgbfix rgblink
Dominant language
C++
Stars
1.6k
Forks
193
Avg merge
1d 33m
Merged PRs (30d)
23

Description

It would be a semver-major breaking change to alter any of these, but we may as well keep track of them for now.

- [ ] Every program supports `-v` for `--verbose` for verbose logging... except RGBFIX, which uses `-v` for `--validate` and has no `--verbose` flag. (`-v` is equivalent to `-f lhg` and is a very common use case for RGBFIX, so changing it would definitely be disruptive.)
- [ ] Every program supports `-w` to disable all warning output... except RGBLINK, which uses `-w` for `--wramx`.
- [ ] `-p` is for `--pad-value` in RGBASM and RGBFIX, but `--pad` in RGBLINK.

Contributor guide

Open the contributing guide

Research direction

Start by locating the CLI flag definitions and help output for RGBASM, RGBFIX, and RGBLINK, then compare the three listed inconsistencies and their existing behavior. Done means the project has an agreed, semver-aware plan for consistent flag naming and the affected programs reflect that plan without overlooking RGBFIX's disruptive -v usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.