From 5dc0bdfe98b59bb03226167ed541d17cc5af30b1 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Tue, 2 Jan 2024 14:32:43 +0100
Subject: docs(glob): add glob module (#26853)

---
 runtime/doc/lua.txt      | 27 +++++++++++++++++++++++++++
 runtime/lua/vim/glob.lua | 18 ++++++++++--------
 2 files changed, 37 insertions(+), 8 deletions(-)

(limited to 'runtime')

diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 7e0ad5f4c3..a8d36d7062 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -2990,6 +2990,33 @@ vim.fs.parents({start})                                     *vim.fs.parents()*
         (string|nil)
 
 
+==============================================================================
+Lua module: vim.glob                                                *vim.glob*
+
+vim.glob.to_lpeg({pattern})                               *vim.glob.to_lpeg()*
+    Parses a raw glob into an |lua-lpeg| pattern.
+
+    This uses glob semantics from LSP 3.17.0: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#pattern
+
+    Glob patterns can have the following syntax:
+    • `*` to match one or more characters in a path segment
+    • `?` to match on one character in a path segment
+    • `**` to match any number of path segments, including none
+    • `{}` to group conditions (e.g. `*.{ts,js}` matches TypeScript and
+      JavaScript files)
+    • `[]` to declare a range of characters to match in a path segment (e.g.,
+      `example.[0-9]` to match on `example.0`, `example.1`, …)
+    • `[!...]` to negate a range of characters to match in a path segment
+      (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not
+      `example.0`)
+
+    Parameters: ~
+      • {pattern}  (string) The raw glob pattern
+
+    Return: ~
+        vim.lpeg.Pattern pattern An |lua-lpeg| representation of the pattern
+
+
 ==============================================================================
 Lua module: vim.secure                                            *vim.secure*
 
diff --git a/runtime/lua/vim/glob.lua b/runtime/lua/vim/glob.lua
index 731179d727..49d6f555da 100644
--- a/runtime/lua/vim/glob.lua
+++ b/runtime/lua/vim/glob.lua
@@ -2,18 +2,20 @@ local lpeg = vim.lpeg
 
 local M = {}
 
---- Parses a raw glob into an |lpeg| pattern.
+--- Parses a raw glob into an |lua-lpeg| pattern.
 ---
 --- This uses glob semantics from LSP 3.17.0: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#pattern
+---
 --- Glob patterns can have the following syntax:
---- `*` to match one or more characters in a path segment
---- `?` to match on one character in a path segment
---- `**` to match any number of path segments, including none
---- `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+--- - `*` to match one or more characters in a path segment
+--- - `?` to match on one character in a path segment
+--- - `**` to match any number of path segments, including none
+--- - `{}` to group conditions (e.g. `*.{ts,js}` matches TypeScript and JavaScript files)
+--- - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+--- - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---
 ---@param pattern string The raw glob pattern
----@return vim.lpeg.Pattern pattern An |lpeg| representation of the pattern
+---@return vim.lpeg.Pattern pattern An |lua-lpeg| representation of the pattern
 function M.to_lpeg(pattern)
   local l = lpeg
 
-- 
cgit