Skip to content

fix: name the path argument dir in CLI help #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bfabio merged 1 commit into from
Nov 12, 2026
Merged

fix: name the path argument dir in CLI help #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions publiccode-parser/publiccode_parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ func run(args []string, stdout, stderr io.Writer) int {
}
localBasePathPtr := flags.String(
"path", "",
"Use this local directory as base path when checking for files existence "+
"instead of using the `url` key in publiccode.yml",
"Use this local `dir` as base path when checking for files existence "+
"instead of using the url key in publiccode.yml",
)
disableNetworkPtr := flags.Bool(
"no-network", false,
Expand Down
6 changes: 5 additions & 1 deletion publiccode-parser/publiccode_parser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,16 @@ func TestRunNoArgumentPrintsUsageOnStderr(t *testing.T) {
}

func TestRunHelpPrintsUsageOnStdout(t *testing.T) {
_, stdout, stderr := runCLI(t, "-help")
_, stdout, stderr := runCLI(t, "--help")

if !strings.HasPrefix(stdout, "Usage: publiccode-parser") {
t.Errorf("expected the usage on stdout, got %q", stdout)
}

if !strings.Contains(stdout, " -path dir\n") {
t.Errorf("expected the path value to be named dir, got %q", stdout)
}

if stderr != "" {
t.Errorf("expected no output on stderr, got %q", stderr)
}
Expand Down
Loading