Skip to content

feat(gui): improve CLI help output and argument validation#10069

Open
joshtrichards wants to merge 8 commits into
masterfrom
jtr/fix-cli-parser-overridelocaldir
Open

feat(gui): improve CLI help output and argument validation#10069
joshtrichards wants to merge 8 commits into
masterfrom
jtr/fix-cli-parser-overridelocaldir

Conversation

@joshtrichards
Copy link
Copy Markdown
Member

@joshtrichards joshtrichards commented May 20, 2026 •
edited
Loading

Summary

Make the GUI's command-line interface easier to use by improving the help text and tightening argument parsing.

Changes

  • rewrite the --help output into clearer grouped sections
  • clarify descriptions for setup wizard and non-interactive provisioning options
  • refactor: group related options logic more clearly in parseOptions()
  • refactor: simplify option matching in parseOptions() with small local helpers
  • report missing values more consistently for value-taking options
  • reject invalid --logexpire values instead of silently treating them as 0
  • document known follow-up areas around --reverse and --overridelocaldir

Notes

  • this is intended as a low-risk cleanup of CLI help and parsing logic
  • delegated command-line parsing via AccountSetupCommandLineManager is unchanged
  • no intended behavior changes beyond clearer errors and stricter --logexpire validation

Follow-up

Potential follow-ups kept out of this PR:

  • decide whether --reverse should set RTL unconditionally
  • validate the path passed to --overridelocaldir
  • revisit whether path-like option values beginning with -- should be accepted
  • validate what --background does and does not do and set expectations accordingly in the help text/etc and address [Bug]: --background not working #5916

Checklist

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

@joshtrichards
fix(application): correct --overridelocaldir hint text in parser
294e826 
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards
fix(app): re-organize, clarify, and expand CLI options output
8d98846 
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards
fix(app): add missing parameter hint to --set-language
1473eff 
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards
refactor(app): re-order parseOptions() logic by type
091542e 
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards
refactor(app): drop shouldExit dead code
0bb252b 
showHint() calls exit itself.

Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards
refactor(app): a tiny bit more parseOptions output polish
f5cfe12 
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards
refactor(app): add small helpers for parseOptions
3216f1b 
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards
chore(app): fixup typo
7ceba7e 
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards joshtrichards added feature: ☁️ GUI System tray icon and menu. 2. developing labels May 20, 2026
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 20, 2026

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)
22 New Code Smells (required ≤ 0)
D Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 20, 2026

Artifact containing the AppImage: nextcloud-appimage-pr-10069.zip

Digest: sha256:da223dddf688f2278cbf412b02a858509e2d1f4120b7f1977698784d6dc19e95

To test this change/fix you can download the above artifact file, unzip it, and run it.

Please make sure to quit your existing Nextcloud app and backup your data.

@joshtrichards joshtrichards marked this pull request as ready for review May 20, 2026 19:07
@joshtrichards joshtrichards mentioned this pull request May 21, 2026
Draft
9 tasks
mgallien
mgallien requested changes Jun 3, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@mgallien mgallien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks 💙

Comment thread src/gui/application.cpp
} else if (isOption(option, "--background")) {
_backgroundMode = true;
} else if (isOption(option, "--reverse")) {
// FIXME: This is current implemented as a toggle, but help text suggests it should set RTL
Copy link
Copy Markdown
Collaborator

@mgallien mgallien Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my bad
it should reverse the usual direction allowing use of French locale (for example) to test RTL layout
maybe you can fix the description of the option ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mgallien mgallien mgallien requested changes

@camilasan camilasan Awaiting requested review from camilasan camilasan is a code owner

@i2h3 i2h3 Awaiting requested review from i2h3 i2h3 is a code owner

@nilsding nilsding Awaiting requested review from nilsding nilsding is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

3. to review feature: ☁️ GUI System tray icon and menu.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@joshtrichards @mgallien