在 Sublime Text 中编写自动完成插件

Writing an autocomplete plugin in Sublime Text

在我的公司内,我们有一个基于 XML 的表示法。在其他功能中,可以定义从一个 XML 文档到另一个文档的引用。 我想在 Sublime 中启用自动完成功能,这样每当我添加引用时,可能的文件(即同一项目中的 XML 文件)和 link 点(即其中的符号)文件)作为推荐提供。

到目前为止,我已经找到了很多可以为 HTML、PHP 或 LaTeX 启用自动完成功能的插件。然而,我觉得代码库对于一个有点简单的任务来说太复杂了。 例如,是否有一些基于作为参数接收的任意数组生成补全的普通函数?我会创建逻辑来确定什么是符号并导出所述数组,但整个过程对我来说似乎有些麻烦。

(注: 我可以在 Python 中编程并摆弄过其他 Sublime 功能,例如片段,但这些包似乎要复杂得多比感觉有必要。)

创建完成条目的基础并不复杂。您现在需要用正确的值填充数组(这可以通过项目设置或解析其他文件来完成)。

import sublime
import sublime_plugin


# Your array, which contains the completions
arr = ["foo", "bar", "baz"]


class MyCompletionsListener(sublime_plugin.EventListener):
    def on_query_completions(self, view, prefix, locations):
        loc = locations[0]

        # limit you completions scope
        if not view.score_selector(loc, "text"):
            return

        completions = [(v + "\tYour Description", v) for v in arr]

        return completions

OP 的注释: 答案与广告一样有效。但是,集成是如此无缝,以至于我想了一会儿,似乎缺少了一些东西。如果上面的 Python 脚本在正确的文件夹中,将建议完成数组返回的所有完成(取决于 Sublime 设置,可能需要使用 Ctrl+Space 触发完成菜单)。另外值得注意的是:

  • completions 可能是 None,在这种情况下,他们只是不添加任何完成选项,或者一个二元组数组,其中第一个元素是描述(它将显示在 drop-down 菜单中并触发完成),第二个是值(即,如果选择完成,将输入的文本)。
  • score_selector 方法可用于确定光标位置是否在给定的 scope.
  • 范围内