├── LICENSE ├── README.md ├── after └── plugin │ └── cmp_luasnip.lua ├── lua └── cmp_luasnip │ └── init.lua └── stylua.toml /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cmp_luasnip 2 | 3 | [luasnip](https://github.com/L3MON4D3/LuaSnip) completion source for [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) 4 | 5 | ```lua 6 | -- Installation 7 | use { 'L3MON4D3/LuaSnip' } 8 | use { 9 | 'hrsh7th/nvim-cmp', 10 | config = function () 11 | require'cmp'.setup { 12 | snippet = { 13 | expand = function(args) 14 | require'luasnip'.lsp_expand(args.body) 15 | end 16 | }, 17 | 18 | sources = { 19 | { name = 'luasnip' }, 20 | -- more sources 21 | }, 22 | } 23 | end 24 | } 25 | use { 'saadparwaiz1/cmp_luasnip' } 26 | ``` 27 | 28 | To disable filtering completion candidates by snippet's `show_condition` 29 | use the following options in `sources`: 30 | 31 | ```lua 32 | sources = { 33 | { name = 'luasnip', option = { use_show_condition = false } }, 34 | -- more sources 35 | }, 36 | ``` 37 | 38 | This can also be configured on per-buffer basis as described in cmp's README 39 | [here](https://github.com/hrsh7th/nvim-cmp#how-to-disable-nvim-cmp-on-the-specific-buffer) 40 | and [here](https://github.com/hrsh7th/nvim-cmp#sources-type-tablecmpsourceconfig). 41 | 42 | The same way you can de-/activate whether autosnippets should be included in the 43 | completion list or not (including them can be a bit problematic since when you 44 | select the entry, the text gets inserted and the snippet automatically 45 | triggers). This option defaults to `false` to be backwards compatible. Example: 46 | 47 | ```lua 48 | sources = { 49 | { name = 'luasnip', option = { show_autosnippets = true } }, 50 | -- more sources 51 | }, 52 | ``` 53 | 54 | Hint: If you want to just hide some autosnippets consider the `hidden` option of 55 | luaSnip 56 | -------------------------------------------------------------------------------- /after/plugin/cmp_luasnip.lua: -------------------------------------------------------------------------------- 1 | require("cmp").register_source("luasnip", require("cmp_luasnip").new()) 2 | 3 | local cmp_luasnip = vim.api.nvim_create_augroup("cmp_luasnip", {}) 4 | 5 | vim.api.nvim_create_autocmd("User", { 6 | pattern = "LuasnipCleanup", 7 | callback = function () 8 | require("cmp_luasnip").clear_cache() 9 | end, 10 | group = cmp_luasnip 11 | }) 12 | 13 | vim.api.nvim_create_autocmd("User", { 14 | pattern = "LuasnipSnippetsAdded", 15 | callback = function () 16 | require("cmp_luasnip").refresh() 17 | end, 18 | group = cmp_luasnip 19 | }) 20 | -------------------------------------------------------------------------------- /lua/cmp_luasnip/init.lua: -------------------------------------------------------------------------------- 1 | local cmp = require("cmp") 2 | local util = require("vim.lsp.util") 3 | 4 | local source = {} 5 | 6 | local defaults = { 7 | use_show_condition = true, 8 | show_autosnippets = false, 9 | } 10 | 11 | -- the options are being passed via cmp.setup.sources, e.g. 12 | -- require('cmp').setup { sources = { { name = 'luasnip', opts = {...} } } } 13 | local function init_options(params) 14 | params.option = vim.tbl_deep_extend('keep', params.option, defaults) 15 | vim.validate({ 16 | use_show_condition = { params.option.use_show_condition, 'boolean' }, 17 | show_autosnippets = { params.option.show_autosnippets, 'boolean' }, 18 | }) 19 | end 20 | 21 | local snip_cache = {} 22 | local doc_cache = {} 23 | 24 | source.clear_cache = function() 25 | snip_cache = {} 26 | doc_cache = {} 27 | end 28 | 29 | source.refresh = function() 30 | local ft = require("luasnip.session").latest_load_ft 31 | snip_cache[ft] = nil 32 | doc_cache[ft] = nil 33 | end 34 | 35 | local function get_documentation(snip, data) 36 | local header = (snip.name or "") .. " _ `[" .. data.filetype .. "]`\n" 37 | local docstring = { "", "```" .. vim.bo.filetype, snip:get_docstring(), "```" } 38 | local documentation = { header .. "---", (snip.dscr or ""), docstring } 39 | documentation = util.convert_input_to_markdown_lines(documentation) 40 | documentation = table.concat(documentation, "\n") 41 | 42 | doc_cache[data.filetype] = doc_cache[data.filetype] or {} 43 | doc_cache[data.filetype][data.snip_id] = documentation 44 | return documentation 45 | end 46 | 47 | source.new = function() 48 | return setmetatable({}, { __index = source }) 49 | end 50 | 51 | source.get_keyword_pattern = function() 52 | return "\\%([^[:alnum:][:blank:]]\\|\\w\\+\\)" 53 | end 54 | 55 | function source:is_available() 56 | local ok, _ = pcall(require, "luasnip") 57 | return ok 58 | end 59 | 60 | function source:get_debug_name() 61 | return "luasnip" 62 | end 63 | 64 | function source:complete(params, callback) 65 | init_options(params) 66 | 67 | local filetypes = require("luasnip.util.util").get_snippet_filetypes() 68 | local items = {} 69 | 70 | for i = 1, #filetypes do 71 | local ft = filetypes[i] 72 | if not snip_cache[ft] then 73 | -- ft not yet in cache. 74 | local ft_items = {} 75 | local ft_table = require("luasnip").get_snippets(ft, {type = "snippets"}) 76 | local iter_tab 77 | if params.option.show_autosnippets then 78 | local auto_table = require('luasnip').get_snippets(ft, {type="autosnippets"}) 79 | iter_tab = {{ft_table, false}, {auto_table, true}} 80 | else 81 | iter_tab = {{ft_table, false}} 82 | end 83 | for _,ele in ipairs(iter_tab) do 84 | local tab,auto = unpack(ele) 85 | for j, snip in pairs(tab) do 86 | if not snip.hidden then 87 | ft_items[#ft_items + 1] = { 88 | word = snip.trigger, 89 | label = snip.trigger, 90 | kind = cmp.lsp.CompletionItemKind.Snippet, 91 | data = { 92 | priority = snip.effective_priority or 1000, -- Default priority is used for old luasnip versions 93 | filetype = ft, 94 | snip_id = snip.id, 95 | show_condition = snip.show_condition, 96 | auto = auto 97 | }, 98 | } 99 | end 100 | end 101 | end 102 | table.sort(ft_items, function(a, b) 103 | return a.data.priority > b.data.priority 104 | end) 105 | snip_cache[ft] = ft_items 106 | end 107 | vim.list_extend(items, snip_cache[ft]) 108 | end 109 | 110 | if params.option.use_show_condition then 111 | local line_to_cursor = params.context.cursor_before_line 112 | items = vim.tbl_filter(function(i) 113 | -- check if show_condition exists in case (somehow) user updated cmp_luasnip but not luasnip 114 | return not i.data.show_condition or i.data.show_condition(line_to_cursor) 115 | end, items) 116 | end 117 | 118 | callback(items) 119 | end 120 | 121 | function source:resolve(completion_item, callback) 122 | local item_snip_id = completion_item.data.snip_id 123 | local snip = require("luasnip").get_id_snippet(item_snip_id) 124 | local doc_itm = doc_cache[completion_item.data.filetype] or {} 125 | doc_itm = doc_itm[completion_item.data.snip_id] or get_documentation(snip, completion_item.data) 126 | completion_item.documentation = { 127 | kind = cmp.lsp.MarkupKind.Markdown, 128 | value = doc_itm, 129 | } 130 | callback(completion_item) 131 | end 132 | 133 | function source:execute(completion_item, callback) 134 | local snip = require("luasnip").get_id_snippet(completion_item.data.snip_id) 135 | 136 | -- if trigger is a pattern, expand "pattern" instead of actual snippet. 137 | if snip.regTrig then 138 | snip = snip:get_pattern_expand_helper() 139 | end 140 | 141 | local cursor = vim.api.nvim_win_get_cursor(0) 142 | -- get_cursor returns (1,0)-indexed position, clear_region expects (0,0)-indexed. 143 | cursor[1] = cursor[1] - 1 144 | local line = require("luasnip.util.util").get_current_line_to_cursor() 145 | 146 | local expand_params = snip:matches(line) 147 | 148 | local clear_region = { 149 | from = { 150 | cursor[1], 151 | cursor[2] - #completion_item.word 152 | }, 153 | to = cursor 154 | } 155 | if expand_params ~= nil then 156 | if expand_params.clear_region ~= nil then 157 | clear_region = expand_params.clear_region 158 | else 159 | if expand_params.trigger ~= nil then 160 | clear_region = { 161 | from = { 162 | cursor[1], 163 | cursor[2] - #expand_params.trigger, 164 | }, 165 | to = cursor, 166 | } 167 | end 168 | end 169 | end 170 | 171 | -- text cannot be cleared before, as TM_CURRENT_LINE and 172 | -- TM_CURRENT_WORD couldn't be set correctly. 173 | require("luasnip").snip_expand(snip, { 174 | -- clear word inserted into buffer by cmp. 175 | -- cursor is currently behind word. 176 | clear_region = clear_region, 177 | expand_params = expand_params, 178 | }) 179 | callback(completion_item) 180 | end 181 | 182 | return source 183 | -------------------------------------------------------------------------------- /stylua.toml: -------------------------------------------------------------------------------- 1 | column_width = 120 2 | line_endings = "Unix" 3 | indent_type = "Tabs" 4 | indent_width = 4 5 | quote_style = "AutoPreferDouble" 6 | no_call_parentheses = false 7 | --------------------------------------------------------------------------------