Skip to content

Make HistorySearchBackward and HistorySearchForward able to navigate the prediction list view #3144

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
merged 1 commit into from
Jan 11, 2022
Merged

Make HistorySearchBackward and HistorySearchForward able to navigate the prediction list view #3144

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
9 changes: 9 additions & 0 deletions PSReadLine/History.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -958,6 +958,11 @@ public static void HistorySearchBackward(ConsoleKeyInfo? key = null, object arg
numericArg = -numericArg;
}

if (UpdateListSelection(numericArg))
{
return;
}

_singleton.SaveCurrentLine();
_singleton.HistorySearch(numericArg);
}
Expand All @@ -969,6 +974,10 @@ public static void HistorySearchBackward(ConsoleKeyInfo? key = null, object arg
public static void HistorySearchForward(ConsoleKeyInfo? key = null, object arg = null)
{
TryGetArgAsInt(arg, out var numericArg, +1);
if (UpdateListSelection(numericArg))
{
return;
}

_singleton.SaveCurrentLine();
_singleton.HistorySearch(numericArg);
Expand Down
205 changes: 203 additions & 2 deletions test/ListPredictionTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ private void AssertDisplayedSuggestions(int count, Guid predictorId, uint sessio
}

[SkippableFact]
public void List_RenderSuggestion_NoMatching()
public void List_RenderSuggestion_NoMatching_DefaultUpArrowDownArrow()
{
TestSetup(KeyMode.Cmd);
using var disp = SetPrediction(PredictionSource.History, PredictionViewStyle.ListView);
Expand All @@ -64,6 +64,25 @@ public void List_RenderSuggestion_NoMatching()
));
}

[SkippableFact]
public void List_RenderSuggestion_NoMatching_HistorySearchBackwardForward()
{
TestSetup(KeyMode.Cmd,
new KeyHandler("Ctrl+p", PSConsoleReadLine.HistorySearchBackward),
new KeyHandler("Ctrl+l", PSConsoleReadLine.HistorySearchForward));
using var disp = SetPrediction(PredictionSource.History, PredictionViewStyle.ListView);

// No matching history entry
SetHistory("echo -bar", "eca -zoo");
Test(string.Empty, Keys(
_.Ctrl_p, CheckThat(() => AssertLineIs("eca -zoo")),
_.Ctrl_p, CheckThat(() => AssertLineIs("echo -bar")),
_.Ctrl_l, _.Ctrl_l,
CheckThat(() => AssertLineIs(string.Empty)),
CheckThat(() => AssertCursorLeftIs(0))
));
}

[SkippableFact]
public void List_RenderSuggestion_ListUpdatesWhileTyping()
{
Expand Down Expand Up @@ -138,7 +157,7 @@ public void List_RenderSuggestion_ListUpdatesWhileTyping()
}

[SkippableFact]
public void List_RenderSuggestion_NavigateInList()
public void List_RenderSuggestion_NavigateInList_DefaultUpArrowDownArrow()
{
TestSetup(KeyMode.Cmd);
int listWidth = CheckWindowSize();
Expand Down Expand Up @@ -317,6 +336,188 @@ public void List_RenderSuggestion_NavigateInList()
));
}

[SkippableFact]
public void List_RenderSuggestion_NavigateInList_HistorySearchBackwardForward()
{
TestSetup(KeyMode.Cmd,
new KeyHandler("Ctrl+p", PSConsoleReadLine.HistorySearchBackward),
new KeyHandler("Ctrl+l", PSConsoleReadLine.HistorySearchForward));
int listWidth = CheckWindowSize();
var emphasisColors = Tuple.Create(PSConsoleReadLineOptions.DefaultEmphasisColor, _console.BackgroundColor);
using var disp = SetPrediction(PredictionSource.History, PredictionViewStyle.ListView);

// Navigate up and down in the list
SetHistory("echo -bar", "eca -zoo");
Test("e", Keys(
'e', CheckThat(() => AssertScreenIs(3,
TokenClassification.Command, 'e',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "ca -zoo",
TokenClassification.None, new string(' ', listWidth - 19), // 19 is the length of '> eca -zoo' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "cho -bar",
TokenClassification.None, new string(' ', listWidth - 20), // 20 is the length of '> echo -bar' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']'
)),
_.Ctrl_l,
CheckThat(() => AssertScreenIs(3,
TokenClassification.Command, "eca",
TokenClassification.None, ' ',
TokenClassification.Parameter, "-zoo",
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.ListPredictionSelected, ' ',
emphasisColors, 'e',
TokenClassification.ListPredictionSelected, "ca -zoo",
TokenClassification.ListPredictionSelected, new string(' ', listWidth - 19), // 19 is the length of '> eca -zoo' plus '[History]'.
TokenClassification.ListPredictionSelected, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.ListPredictionSelected, ']',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "cho -bar",
TokenClassification.None, new string(' ', listWidth - 20), // 20 is the length of '> echo -bar' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']'
)),
_.Ctrl_l,
CheckThat(() => AssertScreenIs(3,
TokenClassification.Command, "echo",
TokenClassification.None, ' ',
TokenClassification.Parameter, "-bar",
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "ca -zoo",
TokenClassification.None, new string(' ', listWidth - 19), // 19 is the length of '> eca -zoo' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.ListPredictionSelected, ' ',
emphasisColors, 'e',
TokenClassification.ListPredictionSelected, "cho -bar",
TokenClassification.ListPredictionSelected, new string(' ', listWidth - 20), // 20 is the length of '> echo -bar' plus '[History]'.
TokenClassification.ListPredictionSelected, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.ListPredictionSelected, ']'
)),
_.Ctrl_l,
CheckThat(() => AssertScreenIs(3,
TokenClassification.Command, 'e',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "ca -zoo",
TokenClassification.None, new string(' ', listWidth - 19), // 19 is the length of '> eca -zoo' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "cho -bar",
TokenClassification.None, new string(' ', listWidth - 20), // 20 is the length of '> echo -bar' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']'
)),
_.Ctrl_p,
CheckThat(() => AssertScreenIs(3,
TokenClassification.Command, "echo",
TokenClassification.None, ' ',
TokenClassification.Parameter, "-bar",
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "ca -zoo",
TokenClassification.None, new string(' ', listWidth - 19), // 19 is the length of '> eca -zoo' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.ListPredictionSelected, ' ',
emphasisColors, 'e',
TokenClassification.ListPredictionSelected, "cho -bar",
TokenClassification.ListPredictionSelected, new string(' ', listWidth - 20), // 20 is the length of '> echo -bar' plus '[History]'.
TokenClassification.ListPredictionSelected, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.ListPredictionSelected, ']'
)),
_.Ctrl_p,
CheckThat(() => AssertScreenIs(3,
TokenClassification.Command, "eca",
TokenClassification.None, ' ',
TokenClassification.Parameter, "-zoo",
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.ListPredictionSelected, ' ',
emphasisColors, 'e',
TokenClassification.ListPredictionSelected, "ca -zoo",
TokenClassification.ListPredictionSelected, new string(' ', listWidth - 19), // 19 is the length of '> eca -zoo' plus '[History]'.
TokenClassification.ListPredictionSelected, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.ListPredictionSelected, ']',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "cho -bar",
TokenClassification.None, new string(' ', listWidth - 20), // 20 is the length of '> echo -bar' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']'
)),
_.Ctrl_p,
CheckThat(() => AssertScreenIs(3,
TokenClassification.Command, 'e',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "ca -zoo",
TokenClassification.None, new string(' ', listWidth - 19), // 19 is the length of '> eca -zoo' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']',
NextLine,
TokenClassification.ListPrediction, '>',
TokenClassification.None, ' ',
emphasisColors, 'e',
TokenClassification.None, "cho -bar",
TokenClassification.None, new string(' ', listWidth - 20), // 20 is the length of '> echo -bar' plus '[History]'.
TokenClassification.None, '[',
TokenClassification.ListPrediction, "History",
TokenClassification.None, ']'
)),
// Once accepted, the list should be cleared.
_.Enter, CheckThat(() => AssertScreenIs(2,
TokenClassification.Command, "e",
NextLine,
NextLine))
));
}

[SkippableFact]
public void List_RenderSuggestion_Escape()
{
Expand Down