intellij-idea - Intellij Idea 实时模板

Question

每次写“todo”评论时，我都面临着写我的 vcs 当前分支名称的问题。

最近我了解了 Intellij 的“Live Templates”，使用起来非常舒服。我尝试将它应用于我的问题，但没有模板可以取出分支名称。

所以问题是我真的可以拿出我的分支名称来以某种方式编写评论代码吗？

Answer 1

可以使用 groovyScript 预定义函数和脚本来提取分支名称。例如创建以下实时模板:

$COMMENT$ todo [$BRANCH$]: $END$

带有缩写“todo”和描述“Inserts todo comment with branch name”。单击编辑变量并为变量提供以下定义:

评论:

lineCommentStart()

BRANCH(针对 2020.2 及更新版本进行了更新)

groovyScript("com.intellij.dvcs.repo.VcsRepositoryManager.getInstance(_editor.project).getRepositoryForFileQuick(com.intellij.openapi.fileEditor.FileDocumentManager.getInstance().getFile(_editor.document)).getCurrentBranchName()")

如果已定义则跳过检查两个变量。 Groovy 脚本(不幸的是)都是一行。将适用的上下文设置为 Everywhere。

使用此实时模板，现在可以在源文件中的某处键入 todoTab 并插入带有分支名称的行注释。这将根据文件的语言插入正确的行注释，或者在没有行注释的语言(如 HTML)的情况下什么也不插入。并且无论使用何种类型的版本控制都应该提取分支名称(我用 Git 测试过)。