feat(lua): add vim-related snippets

Author: TwIStOy

README.md

@@ -26,6 +26,24 @@ ls.setup({
 })
 ```
 
+# Configuration
+
+```lua
+---@type LSSnippets.Config
+{
+  user = {
+    -- user's name, used in todo-related snippets now
+    name = nil,
+  },
+  snippet = {
+    lua = {
+      -- enable neovim related snippets in lua
+      vim_snippet = false,
+    }
+  }
+}
+```
+
 ## Snippets
 
 <details>
@@ -44,12 +62,15 @@ ls.setup({
 <details>
 <summary>Lua</summary>
 
+Snippets with `*` are available only when `vim_snippet` is enabled.
+
 #### Normal Snippets
 
-| Trig  | Desc                                 | Context Required |
-| :---: | ------------------------------------ | :--------------: |
-| `fn`  | Expands to function definition.      |        No        |
-| `req` | Expands to `require(...)` statement. |        No        |
+|  Trig   | Desc                                       | Context Required |
+| :-----: | ------------------------------------------ | :--------------: |
+|  `fn`   | Expands to function definition.            |        No        |
+|  `req`  | Expands to `require(...)` statement.       |        No        |
+| `ifn`\* | Expand to `vim.F.if_nil(...)` expresstion. |        No        |
 
 #### Postfix Snippets
 
@@ -58,14 +79,21 @@ ls.setup({
   (function_call)
   (identifier)
   (expression_list)
+  (dot_index_expression)
+  (bracket_index_expression)
 ] @any_expr
+[
+  (dot_index_expression)
+  (bracket_index_expression)
+] @index_expr
 ```
 
-|   Trig    | Desc (placehoder: `?`)                   | Expr before cursor |
-| :-------: | ---------------------------------------- | :----------------: |
-| `.ipairs` | Expands to `ipairs(?)` for-loop.         |     `any_expr`     |
-| `.pairs`  | Expands to `pairs(?)` for-loop.          |     `any_expr`     |
-| `.isnil`  | Expands to `if ? == nil then` statement. |     `any_expr`     |
+|   Trig    | Desc (placehoder: `?`)                    | Expr before cursor |
+| :-------: | ----------------------------------------- | :----------------: |
+| `.ipairs` | Expands to `ipairs(?)` for-loop.          |     `any_expr`     |
+| `.pairs`  | Expands to `pairs(?)` for-loop.           |     `any_expr`     |
+| `.isnil`  | Expands to `if ? == nil then` statement.  |     `any_expr`     |
+| `.tget`\* | Expands to `vim.tbl_get(...)` expression. |    `index_expr`    |
 
 </details>
 

lua/luasnip-snippets/config.lua

@@ -2,9 +2,17 @@
 ---@field name? string
 ---@field email? string
 
+---@class LSSnippets.Config.Snippet.Lua
+---@field vim_snippet? boolean
+---@field cond? fun():boolean
+
+---@class LSSnippets.Config.Snippet
+---@field lua LSSnippets.Config.Snippet.Lua
+
 ---@class LSSnippets.Config
 ---@field copyright_header? string
 ---@field user? LSSnippets.Config.User
+---@field snippet? LSSnippets.Config.Snippet
 local config = {}
 
 ---@param opts? LSSnippets.Config
@@ -29,7 +37,10 @@ local function get(key)
   return value
 end
 
-return {
+---@class luasnip-snippets.config
+local M = {
   setup = setup,
   get = get,
 }
+
+return M

lua/luasnip-snippets/nodes.lua

@@ -118,9 +118,12 @@ local function word_expand(word, expand, mode)
   }
 end
 
-return {
+---@class luasnip-snippets.nodes
+local M = {
   insert_node = insert_node,
   choice_node = choice_node,
   construct_snippet = construct_snippet,
   word_expand = word_expand,
 }
+
+return M