Merge pull request #9 from ubaldot/improved_MDEIndex

Improved mde index

Author: ubaldot

README.md

@@ -154,10 +154,10 @@ following:
 ### Indices
 
 As the plugin can be used for note-taking, it may be desirable to access
-different indices in an ergonomic way. This can be achieved with the
-`g:markdown_extras_indices` list in combination with the `:MDEIndices`
-command. Note that `g:markdown_extras_indices` is nothing, but a list or a
-dict of files.
+different indices in an ergonomic way. This can be achieved with the command
+`:MDEIndex` that takes `list<string>`, `list<list<string>>` or
+`dict<string>` as argument. If no argument is passed, it reads the content
+of `g:markdown_extras_indices`. See `:h MDEIndex` for more info.
 
 For more information about key-bindings, configuration, etc. take a look at
 `:h markdown-extras`.

autoload/mde_indices.vim

@@ -27,8 +27,15 @@ def IndicesCallback(id: number, idx: number)
         exe $'edit {fnameescape(links.URLToPath(selection))}'
       elseif links.IsURL(selection)
         exe $'Open {selection}'
-      else
+      elseif filereadable(fnameescape(selection))
         exe $'edit {fnameescape(selection)}'
+      elseif selection =~ "^function("
+        try
+          var Tmp = eval(selection)
+          Tmp()
+        catch
+          utils.Echoerr("Function must be global")
+        endtry
       endif
     endif
 
@@ -38,7 +45,6 @@ enddef
 
 export def ShowIndices(passed_indices: string='')
   var indices_found = false
-  echom typename(passed_indices)
 
   if !empty(passed_indices)
     # TODO: remove the eval() with something better

doc/markdown_extras.txt

@@ -251,26 +251,35 @@ COMMANDS                                         *markdown-extras-commands*
 :MDEConvertLinks    Convert inline links into reference-style links.
 
                                                             *:MDEIndex*
-:MDEIndex [{args}]  Open a popup with all the URLs specified in {args}.
+:MDEIndex [{args}]  Open a popup with what is specified in {args}.
 		    The type of {args} can be list<string>, list<list<string>>
 		    or dict<string>. If no argument is passed, then
 		    |g:markdown_extras_indices| is considered.
 		    Example:
 		    >
-	    :MDEIndex  # Uses g:markdown_extras_indices
-	    :MDEIndex ['path1', 'path2', 'path3]
-	    :MDEIndex {foo: 'path1', bar: 'path2', baz: 'path3}
-	    :MDEIndex [['foo', 'path1'], ['bar', 'path2'], ['baz', 'path3]]
+  :MDEIndex  # Uses g:markdown_extras_indices
+  :MDEIndex ['local/path', 'some%20url', 'function("some_Funcref")']
+  :MDEIndex {foo: 'local/path', bar: 'some%20url', 'function("some_Funcref")'}
+  :MDEIndex [['foo', 'local/path'], ['bar', 'some%20url'],
+				      ['baz', 'function("some_Funcref")']]
 <
-		    Or you can use in a script, like for example:
+		    Or it can be used in a script, like for example:
 		    >
-		      const my_index = {
-			foo: '/Users/ubaldot/home/Documents/foo.vim',
-			bar: 'https://example.com',
-			banana: '/mnt/c/files/bar.md'
-		      }
-		      execute $"MDEIndex {my_index}"
+		      def Foo()
+			const my_index = {
+			  foo: '/Users/ubaldot/home/Documents/foo.vim',
+			  bar: 'https://example.com',
+			  banana: 'function("g:Foo")'
+			}
+			execute $"MDEIndex {my_index}"
+		      enddef
+
+		      command! MyIndex Foo()
 <
+		    The string used in the various cases can be a local path,
+		    a valid URL or a function reference.
+		    In the latter case, the referenced function must be global
+		    and shall take no arguments.
 
                                                             *:MDEMake*
 :MDEMake            Invoke |:make| and |:Open| the rendered file. It requires

plugin/markdown_extras.vim

@@ -42,7 +42,7 @@ Typically, they are quite accurate.
 2. `:MDEIndices` has been renamed to `:MDEIndex` and can take an argument, for
 example you can call as `:MDEIndices ['apple', 'banana', 'strawberry']`.
 Furthermore, such a command is no longer valid only for markdown files but
-it become global.
+it become global. See `:h :MDEIndex` for more info.
 
 Press <Esc> to close this popup.
 FOO
@@ -125,4 +125,4 @@ endif
 command! -nargs=0 MDEReleaseNotes ShowReleaseNotes()
 command! -nargs=? MDEIndex indices.ShowIndices(<f-args>)
 
-g:markdown_extras_loaded = false
+g:markdown_extras_loaded = true

test/index_manual_test.vim

@@ -0,0 +1,23 @@
+vim9script
+
+message clear
+
+def g:Foo()
+  echom "Fatto!"
+enddef
+
+var test = [
+  ["file", 'C:\Users\yt75534\vimfiles\plugins\vim-markdown-extras\testfile.md'],
+  ["link", 'https://example.com'],
+  ["func", "function('g:Cazzo')"],
+  ["empty", ""],
+  ["wrong_type", 12234],
+  ["func_lambda", string(() => 'echo "ECCOLA!"')],
+]
+
+var test_safe = [
+  ["file", 'C:\Users\yt75534\vimfiles\plugins\vim-markdown-extras\testfile.md'],
+  ["link", 'https://example.com'],
+  ["global_func", "function('g:Foo')"],
+]
+execute  $"MDEIndex {test_safe}"