Update command palette search to prioritize "longest substring" match.

.github/actions/spelling/excludes.txt

@@ -133,3 +133,4 @@ Resources/(?!en)
 ^\Qsrc/terminal/parser/ft_fuzzwrapper/run.bat\E$
 ^\Qsrc/tools/lnkd/lnkd.bat\E$
 ^\Qsrc/tools/pixels/pixels.bat\E$
+^\Qsrc/cascadia/ut_app/FzfTests.cpp\E$

.github/actions/spelling/expect/expect.txt

@@ -129,7 +129,7 @@
 BLUESCROLL
 bmi
 bodgy
 BODGY
 BOLDFONT
 Borland
 boutput
@@ -651,6 +651,7 @@
 FONTTYPE
 FONTWIDTH
 FONTWINDOW
+foob
 FORCEOFFFEEDBACK
 FORCEONFEEDBACK
 FRAMECHANGED
@@ -668,9 +669,11 @@
 fuzzmain
 fuzzmap
 fuzzwrapper
+fuzzyfinder
 fwdecl
 fwe
 fwlink
+fzf
 gci
 gcx
 gdi
@@ -1248,6 +1251,7 @@
 ONECOREWINDOWS
 onehalf
 oneseq
+oob
 openbash
 opencode
 opencon

NOTICE.md

@@ -285,6 +285,8 @@ specific language governing permissions and limitations under the License.
 **Source**: [https://github.com/commonmark/cmark](https://github.com/commonmark/cmark)
 
 ### License
+
+```
 Copyright (c) 2014, John MacFarlane
 
 All rights reserved.
@@ -455,6 +457,36 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+
+## fzf
+
+### License
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2013-2024 Junegunn Choi
+Copyright (c) 2021-2025 Simon Hauser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```
 
 # Microsoft Open Source
 

src/cascadia/LocalTests_TerminalApp/FilteredCommandTests.cpp

@@ -32,37 +32,35 @@ namespace TerminalAppLocalTests
     {
         auto result = RunOnUIThread([]() {
             const auto paletteItem{ winrt::make<winrt::TerminalApp::implementation::CommandLinePaletteItem>(L"AAAAAABBBBBBCCC") };
+            const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
+
             {
                 Log::Comment(L"Testing command name segmentation with no filter");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                auto segments = filteredCommand->_computeHighlightedName().Segments();
+                auto segments = filteredCommand->HighlightedName().Segments();
                 VERIFY_ARE_EQUAL(segments.Size(), 1u);
                 VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"AAAAAABBBBBBCCC");
                 VERIFY_IS_FALSE(segments.GetAt(0).IsHighlighted());
             }
             {
                 Log::Comment(L"Testing command name segmentation with empty filter");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"";
-                auto segments = filteredCommand->_computeHighlightedName().Segments();
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"")));
+                auto segments = filteredCommand->HighlightedName().Segments();
                 VERIFY_ARE_EQUAL(segments.Size(), 1u);
                 VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"AAAAAABBBBBBCCC");
                 VERIFY_IS_FALSE(segments.GetAt(0).IsHighlighted());
             }
             {
                 Log::Comment(L"Testing command name segmentation with filter equal to the string");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"AAAAAABBBBBBCCC";
-                auto segments = filteredCommand->_computeHighlightedName().Segments();
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"AAAAAABBBBBBCCC")));
+                auto segments = filteredCommand->HighlightedName().Segments();
                 VERIFY_ARE_EQUAL(segments.Size(), 1u);
                 VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"AAAAAABBBBBBCCC");
                 VERIFY_IS_TRUE(segments.GetAt(0).IsHighlighted());
             }
             {
                 Log::Comment(L"Testing command name segmentation with filter with first character matching");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"A";
-                auto segments = filteredCommand->_computeHighlightedName().Segments();
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"A")));
+                auto segments = filteredCommand->HighlightedName().Segments();
                 VERIFY_ARE_EQUAL(segments.Size(), 2u);
                 VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"A");
                 VERIFY_IS_TRUE(segments.GetAt(0).IsHighlighted());
@@ -71,9 +69,8 @@ namespace TerminalAppLocalTests
             }
             {
                 Log::Comment(L"Testing command name segmentation with filter with other case");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"a";
-                auto segments = filteredCommand->_computeHighlightedName().Segments();
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"a")));
+                auto segments = filteredCommand->HighlightedName().Segments();
                 VERIFY_ARE_EQUAL(segments.Size(), 2u);
                 VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"A");
                 VERIFY_IS_TRUE(segments.GetAt(0).IsHighlighted());
@@ -82,24 +79,20 @@ namespace TerminalAppLocalTests
             }
             {
                 Log::Comment(L"Testing command name segmentation with filter matching several characters");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"ab";
-                auto segments = filteredCommand->_computeHighlightedName().Segments();
-                VERIFY_ARE_EQUAL(segments.Size(), 4u);
-                VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"A");
-                VERIFY_IS_TRUE(segments.GetAt(0).IsHighlighted());
-                VERIFY_ARE_EQUAL(segments.GetAt(1).TextSegment(), L"AAAAA");
-                VERIFY_IS_FALSE(segments.GetAt(1).IsHighlighted());
-                VERIFY_ARE_EQUAL(segments.GetAt(2).TextSegment(), L"B");
-                VERIFY_IS_TRUE(segments.GetAt(2).IsHighlighted());
-                VERIFY_ARE_EQUAL(segments.GetAt(3).TextSegment(), L"BBBBBCCC");
-                VERIFY_IS_FALSE(segments.GetAt(3).IsHighlighted());
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"ab")));
+                auto segments = filteredCommand->HighlightedName().Segments();
+                VERIFY_ARE_EQUAL(segments.Size(), 3u);
+                VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"AAAAA");
+                VERIFY_IS_FALSE(segments.GetAt(0).IsHighlighted());
+                VERIFY_ARE_EQUAL(segments.GetAt(1).TextSegment(), L"AB");
+                VERIFY_IS_TRUE(segments.GetAt(1).IsHighlighted());
+                VERIFY_ARE_EQUAL(segments.GetAt(2).TextSegment(), L"BBBBBCCC");
+                VERIFY_IS_FALSE(segments.GetAt(2).IsHighlighted());
             }
             {
                 Log::Comment(L"Testing command name segmentation with non matching filter");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"abcd";
-                auto segments = filteredCommand->_computeHighlightedName().Segments();
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"abcd")));
+                auto segments = filteredCommand->HighlightedName().Segments();
                 VERIFY_ARE_EQUAL(segments.Size(), 1u);
                 VERIFY_ARE_EQUAL(segments.GetAt(0).TextSegment(), L"AAAAAABBBBBBCCC");
                 VERIFY_IS_FALSE(segments.GetAt(0).IsHighlighted());
@@ -113,53 +106,37 @@ namespace TerminalAppLocalTests
     {
         auto result = RunOnUIThread([]() {
             const auto paletteItem{ winrt::make<winrt::TerminalApp::implementation::CommandLinePaletteItem>(L"AAAAAABBBBBBCCC") };
-            {
-                Log::Comment(L"Testing weight of command with no filter");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                auto weight = filteredCommand->_computeWeight();
-                VERIFY_ARE_EQUAL(weight, 0);
-            }
-            {
-                Log::Comment(L"Testing weight of command with empty filter");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"";
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                auto weight = filteredCommand->_computeWeight();
-                VERIFY_ARE_EQUAL(weight, 0);
-            }
-            {
-                Log::Comment(L"Testing weight of command with filter equal to the string");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"AAAAAABBBBBBCCC";
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                auto weight = filteredCommand->_computeWeight();
-                VERIFY_ARE_EQUAL(weight, 30); // 1 point for the first char and 2 points for the 14 consequent ones + 1 point for the beginning of the word
-            }
-            {
-                Log::Comment(L"Testing weight of command with filter with first character matching");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"A";
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                auto weight = filteredCommand->_computeWeight();
-                VERIFY_ARE_EQUAL(weight, 2); // 1 point for the first char match + 1 point for the beginning of the word
-            }
-            {
-                Log::Comment(L"Testing weight of command with filter with other case");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"a";
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                auto weight = filteredCommand->_computeWeight();
-                VERIFY_ARE_EQUAL(weight, 2); // 1 point for the first char match + 1 point for the beginning of the word
-            }
-            {
-                Log::Comment(L"Testing weight of command with filter matching several characters");
-                const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"ab";
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                auto weight = filteredCommand->_computeWeight();
-                VERIFY_ARE_EQUAL(weight, 3); // 1 point for the first char match + 1 point for the beginning of the word + 1 point for the match of "b"
-            }
+            const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
+
+            const auto weigh = [&](const wchar_t* str) {
+                std::shared_ptr<fzf::matcher::Pattern> pattern;
+                if (str)
+                {
+                    pattern = std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(str));
+                }
+                filteredCommand->UpdateFilter(std::move(pattern));
+                return filteredCommand->Weight();
+            };
+
+            const auto null = weigh(nullptr);
+            const auto empty = weigh(L"");
+            const auto full = weigh(L"AAAAAABBBBBBCCC");
+            const auto firstChar = weigh(L"A");
+            const auto otherCase = weigh(L"a");
+            const auto severalChars = weigh(L"ab");
+
+            VERIFY_ARE_EQUAL(null, 0);
+            VERIFY_ARE_EQUAL(empty, 0);
+            VERIFY_IS_GREATER_THAN(full, 100);
+
+            VERIFY_IS_GREATER_THAN(firstChar, 0);
+            VERIFY_IS_LESS_THAN(firstChar, full);
+
+            VERIFY_IS_GREATER_THAN(otherCase, 0);
+            VERIFY_IS_LESS_THAN(otherCase, full);
+
+            VERIFY_IS_GREATER_THAN(severalChars, otherCase);
+            VERIFY_IS_LESS_THAN(severalChars, full);
         });
 
         VERIFY_SUCCEEDED(result);
@@ -181,31 +158,23 @@ namespace TerminalAppLocalTests
             {
                 Log::Comment(L"Testing comparison of commands with empty filter");
                 const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"";
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                filteredCommand->_Weight = filteredCommand->_computeWeight();
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"")));
 
                 const auto filteredCommand2 = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem2);
-                filteredCommand2->_Filter = L"";
-                filteredCommand2->_HighlightedName = filteredCommand2->_computeHighlightedName();
-                filteredCommand2->_Weight = filteredCommand2->_computeWeight();
+                filteredCommand2->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"")));
 
                 VERIFY_ARE_EQUAL(filteredCommand->Weight(), filteredCommand2->Weight());
                 VERIFY_IS_TRUE(winrt::TerminalApp::implementation::FilteredCommand::Compare(*filteredCommand, *filteredCommand2));
             }
             {
                 Log::Comment(L"Testing comparison of commands with different weights");
                 const auto filteredCommand = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem);
-                filteredCommand->_Filter = L"B";
-                filteredCommand->_HighlightedName = filteredCommand->_computeHighlightedName();
-                filteredCommand->_Weight = filteredCommand->_computeWeight();
+                filteredCommand->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"B")));
 
                 const auto filteredCommand2 = winrt::make_self<winrt::TerminalApp::implementation::FilteredCommand>(paletteItem2);
-                filteredCommand2->_Filter = L"B";
-                filteredCommand2->_HighlightedName = filteredCommand2->_computeHighlightedName();
-                filteredCommand2->_Weight = filteredCommand2->_computeWeight();
+                filteredCommand2->UpdateFilter(std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(L"B")));
 
-                VERIFY_IS_TRUE(filteredCommand->Weight() < filteredCommand2->Weight()); // Second command gets more points due to the beginning of the word
+                VERIFY_IS_LESS_THAN(filteredCommand->Weight(), filteredCommand2->Weight()); // Second command gets more points due to the beginning of the word
                 VERIFY_IS_FALSE(winrt::TerminalApp::implementation::FilteredCommand::Compare(*filteredCommand, *filteredCommand2));
             }
         });

src/cascadia/TerminalApp/CommandPalette.cpp

@@ -1174,12 +1174,15 @@ namespace winrt::TerminalApp::implementation
         }
         else if (_currentMode == CommandPaletteMode::TabSearchMode || _currentMode == CommandPaletteMode::ActionMode || _currentMode == CommandPaletteMode::CommandlineMode)
         {
+            auto pattern = std::make_shared<fzf::matcher::Pattern>(fzf::matcher::ParsePattern(searchText));
+
             for (const auto& action : commandsToFilter)
             {
                 // Update filter for all commands
                 // This will modify the highlighting but will also lead to re-computation of weight (and consequently sorting).
                 // Pay attention that it already updates the highlighting in the UI
-                action.UpdateFilter(searchText);
+                auto impl = winrt::get_self<implementation::FilteredCommand>(action);
+                impl->UpdateFilter(pattern);
 
                 // if there is active search we skip commands with 0 weight
                 if (searchText.empty() || action.Weight() > 0)