如何为VSCode扩展添加自定义自动补全项排序规则？

本文共计2512个文字，预计阅读时间需要11分钟。

VSCode扩展需要提供自定义的自动补全项排序规则，核心在于巧妙地利用CompletionItem对象中的sortText和filterText属性。VSCode的自动补全机制会根据这些属性来确定最终的显示顺序。因此，作为扩展开发者，我们的主要任务是通过精确设置这些值来指引最终展示的顺序。

解决方案

要实现自定义的自动补全项排序，关键在于为每个

CompletionItem设置其

sortText属性。这个属性是一个字符串，VSCode会根据它的字典序（lexicographical order）来对补全项进行排序。这意味着，如果你希望某个补全项排在前面，就给它的

sortText赋予一个字典序上靠前的字符串值。

例如，你可以使用数字前缀来控制优先级：

"0_exactMatch"会排在

"1_commonItem"之前，而

"1_commonItem"又会排在

"2_lessUsed"之前。通过这种方式，我们可以将最相关、最常用的补全项“顶”到列表顶部，而将那些次要的、或需要用户进一步思考的项排在后面。

filterText则主要用于匹配用户输入，它决定了哪些补全项会被显示出来。虽然它不直接参与最终的排序，但在某些情况下，如果

sortText缺失，VSCode可能会回退到使用

filterText进行辅助排序。但通常，我们更多地依赖

sortText来精确控制顺序。