RFC for ArgumentCompleter base class

Offen

#270 erstellt am 25.11.2020 0 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 35/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: powershell
Bereich: cli

Rechercherichtung

Beginne mit dem Lesen des referenzierten Issues #269 und des vorgeschlagenen ArgumentCompleter-Beispiels in diesem RFC. Arbeite die angeforderten allgemeinen Verhaltensweisen durch – das Zitieren von Argumenten, das Abgleichen von WordToComplete und das Sortieren von Ergebnissen – und definiere die API der Basisklasse sowie die Abschlusssemantik. Als erledigt gilt die Aufgabe, wenn der RFC ein festgelegtes Design für benutzerdefinierte ArgumentCompleter und ein konsistentes Abschlussverhalten enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

#269

Provide a base class, ArgumentCompleter, to simplify writing custom argument completers

Some common tasks need to be done almost every time a completer is written.

Things like quoting arguments if they contain spaces, matching against WordToComplete, and ensuring that the results are sorted is another such task.

Motivation

As a Developer,
I can use the base class when writing custom argument completers,
so that results are achieved faster, with high quality, and
so that users get a consistent completion experience.

User Experience

using namespace System.Management.Automation;

public class GetCommitCompleter : ArgumentCompleter
{
    // override simplified completer
    protected override CompletionResultSortKind AddCompletionsFor(string commandName, string parameterName, IDictionary fakeBoundParameters)
    {
        switch (parameterName)
        {
            case nameof(GitRebaseCommand.CommitHash):
                CompleteGitCommitHash();
                break;
        }

        return CompletionResultSortKind.Sorted;
    }

    private void CompleteGitCommitHash()
    {
        var user = GetFakeBoundParameter<string>("User");
        foreach(var commit in GitExe.Log())
        {
            if (user is { } u && commit.User != u){
                continue;
            }
            // use a function to complete if the text or tooltip matches WordToComplete
            CompleteMatching(text: commit.Hash, tooltip: $"{commit.User}\r\n{commit.Description}}": CompletionMatch.AnyContainsWithWordToComplete);
        }
    }
}

Vorherrschende Sprache: PowerShell
Sterne: 468
Forks: 143
Ø Merge: 9 Min.
Gemergte PRs (30 T.): 1

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus PowerShell/PowerShell-RFC

Update template Plan to implement to allow additional option Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

PowerShell/PowerShell-RFC#404 · 1 Kommentar · Erstellt am 07.12.2025
PowerShell Community Dashboard: No Data After October 2024 Offen

PowerShell/PowerShell-RFC#407 · 1 Kommentar · 1 zugewiesene Person · Erstellt am 13.2.2026
Handling enums as cmdlet parameters. Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

PowerShell/PowerShell-RFC#396 · Erstellt am 28.7.2025
Idea: Is there a need for having ExecutionPolicy for PS7 and WinPS be mirrored? Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100

PowerShell/PowerShell-RFC#334 · 2 Reaktionen · Erstellt am 26.9.2022
Idea: Release the SecretManagement and SecretStore modules with PowerShell Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

PowerShell/PowerShell-RFC#327 · 28 Kommentare · 31 Reaktionen · Erstellt am 06.7.2022

Alle Issues in PowerShell/PowerShell-RFC