Merge pull request #30979 from zeertzjq/vim-9.1.0810

vim-patch:9.1.{0810,0811,0821}: 'findexpr'

1 files changed, 59 insertions, 0 deletions

diff --git a/src/nvim/options.lua b/src/nvim/options.lua
index a891d18364..d59958eaf2 100644
--- a/src/nvim/options.lua
+++ b/src/nvim/options.lua
@@ -2906,6 +2906,65 @@ return {
       varname = 'p_fcs',
     },
     {
+      abbreviation = 'fexpr',
+      cb = 'did_set_optexpr',
+      defaults = { if_true = '' },
+      desc = [=[
+        Expression that is evaluated to obtain the filename(s) for the |:find|
+        command.  When this option is empty, the internal |file-searching|
+        mechanism is used.
+
+        While evaluating the expression, the |v:fname| variable is set to the
+        argument of the |:find| command.
+
+        The expression is evaluated only once per |:find| command invocation.
+        The expression can process all the directories specified in 'path'.
+
+        The expression may be evaluated for command-line completion as well,
+        in which case the |v:cmdcomplete| variable will be set to |v:true|,
+        otherwise it will be set to |v:false|.
+
+        If a match is found, the expression should return a |List| containing
+        one or more file names.  If a match is not found, the expression
+        should return an empty List.
+
+        If any errors are encountered during the expression evaluation, an
+        empty List is used as the return value.
+
+        Using a function call without arguments is faster |expr-option-function|
+
+        It is not allowed to change text or jump to another window while
+        evaluating 'findexpr' |textlock|.
+
+        This option cannot be set from a |modeline| or in the |sandbox|, for
+        security reasons.
+
+        Examples:
+        >vim
+            " Use glob()
+            func FindExprGlob()
+        	let pat = v:cmdcomplete ? $'{v:fname}*' : v:fname
+        	return glob(pat, v:false, v:true)
+            endfunc
+            set findexpr=FindExprGlob()
+
+            " Use the 'git ls-files' output
+            func FindGitFiles()
+        	let fnames = systemlist('git ls-files')
+        	return fnames->filter('v:val =~? v:fname')
+            endfunc
+            set findexpr=FindGitFiles()
+        <
+      ]=],
+      full_name = 'findexpr',
+      scope = { 'global', 'buffer' },
+      secure = true,
+      short_desc = N_('expression used for :find'),
+      tags = { 'E1514' },
+      type = 'string',
+      varname = 'p_fexpr',
+    },
+    {
       abbreviation = 'fixeol',
       cb = 'did_set_eof_eol_fixeol_bomb',
       defaults = { if_true = true },