Skip to content

Show help when mandatory CLI parameters are missing #421

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
sensslen merged 3 commits into from
Feb 4, 2026
Merged

Show help when mandatory CLI parameters are missing #421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11d1f11
Initial plan
Copilot Feb 3, 2026
ca0bb47
Add validation to show help when mandatory parameters are missing
Copilot Feb 3, 2026
4075abf
Address code review feedback - reuse variables and improve documentation
Copilot Feb 3, 2026
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
11 changes: 8 additions & 3 deletions src/NuGetLicense/CommandLineOptionsParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,14 @@ public string[] GetInputFiles(string? inputFile, string? inputJsonFile)
return [inputFile];
}

return inputJsonFile != null
? JsonSerializer.Deserialize<string[]>(_fileSystem.File.ReadAllText(inputJsonFile))!
: throw new ArgumentException("Please provide an input file using --input or --json-input");
if (inputJsonFile != null)
{
return JsonSerializer.Deserialize<string[]>(_fileSystem.File.ReadAllText(inputJsonFile))!;
}

// Defensive check: validation should already be done at command line parsing level,
// but throw exception if called directly or if validation is bypassed
throw new ArgumentException("Please provide an input file using --input or --json-input");
}

public string[] GetAllowedLicenses(string? allowedLicenses)
Expand Down
18 changes: 16 additions & 2 deletions src/NuGetLicense/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,24 @@ public static RootCommand CreateRootCommand()

rootCommand.SetAction(async (parseResult, cancellationToken) =>
{
string? inputFile = parseResult.GetValue(inputFileOption);
string? inputJsonFile = parseResult.GetValue(inputJsonFileOption);

// Check if mandatory parameters are provided
if (inputFile == null && inputJsonFile == null)
{
Console.Error.WriteLine("Error: Please provide an input file using --input or --json-input");
Console.Error.WriteLine();
// Show help by parsing and invoking with --help argument
ParseResult helpResult = rootCommand.Parse(new[] { "--help" });
await helpResult.InvokeAsync();
return 1;
}

var options = new CommandLineOptions
{
InputFile = parseResult.GetValue(inputFileOption),
InputJsonFile = parseResult.GetValue(inputJsonFileOption),
InputFile = inputFile,
InputJsonFile = inputJsonFile,
IncludeTransitive = parseResult.GetValue(includeTransitiveOption),
AllowedLicenses = parseResult.GetValue(allowedLicensesOption),
IgnoredPackages = parseResult.GetValue(ignoredPackagesOption),
Expand Down
Loading