dotnet/command-line-api

GetCompletions should check exit code of invoked application

Open

#2,137 opened on Mar 31, 2023

View on GitHub
 (1 comment) (3 reactions) (0 assignees)C# (3,665 stars) (421 forks)auto 404
Area-Completionsbughelp wanted

Description

This code should probably check the exit code and not consider standard output to be completions when it is non-zero:

https://github.com/dotnet/command-line-api/blob/403234a4c4247151d09073bc07ccc13530ce62c6/src/System.CommandLine.Suggest/SuggestionStore.cs#L47-L50

cc @jonsequitur @adamsitnik

Contributor guide

Tech stack
csharp
Domain
cli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C# basicsunderstanding of exit codes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue is in SuggestionStore.cs at lines 47-50 (linked in the issue). Currently, the code invokes the application and reads stdout without checking the exit code. The fix is to add a check after invocation: if exit code is non zero, ignore stdout. A maintainer has confirmed this is a valid bug. No other files need changes.