LuaSnip下载 - LuaSnip源码下载

LuaSnip

其他源码

v2.3.0

下载

卢阿剪辑

javadoc.mp4

特征

制表位
使用 Lua 函数进行文本转换
有条件扩展
定义嵌套片段
文件类型特定的片段
选择
动态片段创建
正则表达式触发器
自动触发的片段
简单的 Postfix 片段
快速地
直接在 Lua 中解析 LSP 样式片段作为 VSCode 包或 SnipMate 片段集合。
使用 nvim-compe（或其后继者 nvim-cmp（需要 cmp_luasnip））扩展 LSP-Snippets
片段历史（跳回旧片段）
使用 Treesitter 解析光标处的文件类型

缺点

使用该插件全部功能的片段必须在 Lua 中定义（但 95% 的片段可以用 LSP 语法编写）。

要求

Neovim >= 0.7 (extmarks) 用于lsp-snippet-transformations的jsregexp （有关安装它的一些提示，请参阅此处）。

设置

安装

使用您首选的插件管理器，即 vim-plug、Packer 或lazy
包装工：

 use ({
	" L3MON4D3/LuaSnip " ,
	-- follow latest release.
	tag = " v2.* " , -- Replace <CurrentMajor> by the latest released major (first number of latest release)
	-- install jsregexp (optional!:).
	run = " make install_jsregexp "
})

懒惰的：

{
	" L3MON4D3/LuaSnip " ,
	-- follow latest release.
	version = " v2.* " , -- Replace <CurrentMajor> by the latest released major (first number of latest release)
	-- install jsregexp (optional!).
	build = " make install_jsregexp "
}

vim 插件：

 " follow latest release and install jsregexp.
Plug ' L3MON4D3/LuaSnip ' , { ' tag ' : ' v2.* ' , ' do ' : ' make install_jsregexp ' } " Replace <CurrentMajor> by the latest released major (first number of latest release)

检查右侧的Releases部分以获取最新的主要版本。

LuaSnip 使用语义版本控制（有一些余地，大补丁可能最终会成为次要版本）！
版本将被标记为vMajor.Minor.Patch ，我们建议遵循最新的主要版本。
考虑查看存储库的版本，以便在新版本可用时您会收到通知。

笔记

在 Windows 上，您需要使用可以运行 Unix 命令（MinGW、MSYS2 等）的 shell。幸运的是，Git 提供了sh.exe ，因此您不需要安装繁重的 MSYS2 环境。除了 Git 之外，您还需要 C 编译器和make来安装jsregexp 。您可能还需要更改构建命令： make install_jsregexp CC=gcc.exe SHELL=C:/path/to/sh.exe .SHELLFLAGS=-c ：

 SHELL=C:/path/to/Git/usr/bin/sh.exe # if Git/MinGW/MSYS2 `sh.exe` is not in PATH
.SHELLFLAGS=-c # if Git/MinGW/MSYS2 `sh.exe` is not in PATH
CC=gcc.exe # if CC's default value cc is not set (when `which cc` fails to find the compiler command)
NEOVIM_BIN_PATH=C:/path/to/Neovim/bin # if the Makefile fails to automatically detect the Neovim/bin path

键位图

在 Vim 脚本中，使用<Tab>向前跳转/展开片段，使用<Shift-Tab>向后跳转，使用<Ctrl-E>在choiceNode中更改当前选择...

 " press <Tab> to expand or jump in a snippet. These can also be mapped separately
" via <Plug>luasnip-expand-snippet and <Plug>luasnip-jump-next.
imap <silent> <expr> <Tab> luasnip#expand_or_jumpable() ? ' <Plug> luasnip-expand-or-jump' : ' <Tab> '
" -1 for jumping backwards.
inoremap <silent> <S-Tab> <cmd> lua require'luasnip'.jump(-1) <Cr>

snoremap <silent> <Tab> <cmd> lua require('luasnip').jump(1) <Cr>
snoremap <silent> <S-Tab> <cmd> lua require('luasnip').jump(-1) <Cr>

" For changing choices in choiceNodes (not strictly necessary for a basic setup).
imap <silent> <expr> <C-E> luasnip#choice_active() ? ' <Plug> luasnip-next-choice' : ' <C-E> '
smap <silent> <expr> <C-E> luasnip#choice_active() ? ' <Plug> luasnip-next-choice' : ' <C-E> '

...或者在Lua中，使用一组不同的键： <Ctrl-K>用于扩展， <Ctrl-L>用于向前跳转， <Ctrl-J>用于向后跳转， <Ctrl-E>用于更改活动选择。

 local ls = require ( " luasnip " )

vim . keymap . set ({ " i " }, " <C-K> " , function () ls . expand () end , { silent = true })
vim . keymap . set ({ " i " , " s " }, " <C-L> " , function () ls . jump ( 1 ) end , { silent = true })
vim . keymap . set ({ " i " , " s " }, " <C-J> " , function () ls . jump ( - 1 ) end , { silent = true })

vim . keymap . set ({ " i " , " s " }, " <C-E> " , function ()
	if ls . choice_active () then
		ls . change_choice ( 1 )
	end
end , { silent = true })

nvim-cmp的 wiki 还包含一个设置超级选项卡式映射的示例。

添加片段

查看文档以获取有关加载程序及其优点的一般说明。以下列表仅作为简短概述。

类似 VS Code ：要使用插件中现有的 VS Code 样式片段（例如 rafamadriz/friend-snippets），只需安装插件，然后添加
```
 require ( " luasnip.loaders.from_vscode " ). lazy_load ()
```
在你的 Neovim 配置中的某个地方。 LuaSnip 将在启动时加载插件中包含的片段。您还可以通过将自定义代码片段目录的路径传递给加载函数来轻松加载您自己的自定义 VSCode 样式代码片段：
```
 -- load snippets from path/of/your/nvim/config/my-cool-snippets
require ( " luasnip.loaders.from_vscode " ). lazy_load ({ paths = { " ./my-cool-snippets " } })
```
有关 VS Code 加载器的更多信息，请查看示例或文档。
SnipMate-like ：与 VS Code 包非常相似；安装一个提供片段的插件并调用load函数：
```
 require ( " luasnip.loaders.from_snipmate " ). lazy_load ()
```
SnipMate 格式非常简单，因此添加自定义片段只需要几个步骤：
- 在init.vim旁边（或runtimepath中的任何其他位置）添加一个名为snippets目录。
- 在该目录中，创建名为<filetype>.snippets的文件，并在其中添加给定文件类型的片段（如需灵感，请检查 honza/vim-snippets）。
```
 # comment
snippet <trigger> <description>
<snippet-body>
snippet if C-style if
if ( $1 )
	$0
```
同样，有一些示例和文档。
Lua ：通过调用require("luasnip").add_snippets(filetype, snippets)添加片段。可以在此处找到相关示例。
通过使用 Lua 的加载器，这也可以做得更干净，具有使用加载器带来的所有好处

还有一个收集各种语言片段的存储库，molleweide/LuaSnip-snippets.nvim

文档

入门

您有两个主要选择：使用 SnipMate/VS 代码片段（更简单）或在 Lua 中编写片段（更复杂但功能更丰富）。以下是针对这两种情况的一些入门建议：

SnipMate 或 VS Code 片段：如果您只想编写/加载 SnipMate 或 VS Code 片段并忽略 Lua 片段（如果您还不需要 Lua 片段更复杂的功能，则绝对推荐这样做），请查看有关加载的部分DOC.md中的 VS Code 或 SnipMate 包。在这两者中，SnipMate 绝对是编写片段的更舒适的方式。
Lua 片段：我们建议首先观看或阅读下面“新用户资源”部分中的介绍性指南之一。熟悉基础知识后，您应该查看以下列表中的重要 LuaSnip 功能：
- config ：值得注意的是： region_check_events用于跳转到光标不再位于其中的片段的末尾， delete_check_events用于清理文本已删除的片段， enable_autosnippets用于启用自动片段扩展。
- extras ：该模块包含许多功能，使编写代码片段变得更加容易； fmt和lambda特别有用。
- lua-loader ：一种非常有用的加载片段的方法，比调用add_snippets更舒服。
  还支持热重载（仅限于与编辑的文件位于同一 Neovim 实例中的缓冲区）和跳转到为当前缓冲区提供片段的文件。
- 高级节点： functionNode 、 dynamicNode 、 choiceNode和restoreNode 。
  TJ DeVries 在这段视频中很好地解释了前三个，而不是在文档中阅读它们。

官方文档和示例

注意：您可能需要查看下面的“新用户资源”部分，而不是立即阅读官方文档，因为这些文档更多地是作为参考手册而不是新用户教程编写的。

DOC.md是主要文档 - 它概述了如何编写代码片段，解释了每个 LuaSnip 节点的角色和用例，展示了如何从 Lua、VS Code 和 SnipMate 格式加载代码片段，并涵盖了可用的 LuaSnip API 。
:help luasnip.txt是DOC.md的纯文本版本，可通过 Neovim 的:help功能使用。
文件Examples/snippets.lua包含许多用 Lua 编写的示例片段 - 我们强烈建议在使用 LuaSnip 的高级功能之前浏览（或者更好的是:luafile ing）这些示例片段。
Wiki 包含一些有用的 LuaSnip 扩展以及一些高级片段和配置的示例。
配置也记录在DOC.md中。

【中文版】中文DOC来了。

新用户资源

以下是网络上的一些 LuaSnip 视频和教程：

由唯一一位 TJ DeVries 制作的介绍性和高级 YouTube 视频。不幸的是，自从录制这些视频以来，LuaSnip 发生了一些重大变化：
- 现在通过ls.add_snippets添加代码片段，而不是使用ls.snippets = {}
使用 LaTeX 主题的 GIF 和 @ejmastnak 的现实生活示例在 Lua 中编写片段的指南
@evesdropper 的 LuaSnip 指南集合，其中大部分也在 LaTeX 上下文中
Ziontee113 为初学者准备的 LuaSnip 入门视频教程

受到 vsnip.vim 的启发

展开

附加信息