Auto generate docs

L3MON4D3 · Mar 27, 2023 · 91db50e · 91db50e
1 parent 2909a27
commit 91db50e
Showing 1 changed file with 29 additions and 2 deletions.
diff --git a/doc/luasnip.txt b/doc/luasnip.txt
@@ -40,7 +40,8 @@ Table of Contents                                  *luasnip-table-of-contents*
 17. LSP-Snippets                                        |luasnip-lsp-snippets|
   - Snipmate Parser                     |luasnip-lsp-snippets-snipmate-parser|
   - Transformations                     |luasnip-lsp-snippets-transformations|
-18. Variables                                              |luasnip-variables|
+  - VSCode snippet extra fields|luasnip-lsp-snippets-vscode-snippet-extra-fields|
+18. VARIABLES                                              |luasnip-variables|
   - Environment Namespaces          |luasnip-variables-environment-namespaces|
   - LSP-Variables                            |luasnip-variables-lsp-variables|
 19. Loaders                                                  |luasnip-loaders|
@@ -1838,8 +1839,34 @@ Alternatively, `jsregexp` can be cloned locally, `make`d, and the resulting
 If `jsregexp` is not available, transformations are replaced by a simple copy.
 
 
+VSCODE SNIPPET EXTRA FIELDS *luasnip-lsp-snippets-vscode-snippet-extra-fields*
+
+
+  **Note** See also this Issue 705
+  <https://github.com/L3MON4D3/LuaSnip/issues/705> for more info
+>json
+
+        {
+            "prefix": ...
+            "scope": "javascript,typescript",
+            "body": ...
+        }
+<
+
+The `"scope":`
+<https://code.visualstudio.com/docs/editor/userdefinedsnippets#_snippet-scope>
+field is honored when loaded into the LuaSnip engine. If it isn’t part of the
+current buffer (editor) language, then it’s not imported. Let’s say you
+have `shared.json` that has snippets for different languages specified via
+`scope`. When specific language mapped to a `.code-snippets` (or `.json`) file
+by a `package.json` then only snippets `scope`-ed to the same language are
+loaded. The rest is ignored.
+
+`"isFileTemplate" :` field isn’t handled in anyway.
+
+
 ==============================================================================
-18. Variables                                              *luasnip-variables*
+18. VARIABLES                                              *luasnip-variables*
 
 All `TM_something`-variables are supported with two additions: `LS_SELECT_RAW`
 and `LS_SELECT_DEDENT`. These were introduced because `TM_SELECTED_TEXT` is