feat(cli): Add docname glob filter for list subcommand (#29)

Author: SilverRainZ

src/sphinxnotes/snippet/cli.py

@@ -9,17 +9,18 @@
 from __future__ import annotations
 import sys
 import argparse
-from typing import List
+from typing import List, Iterable, Tuple
 from os import path
 from textwrap import dedent
 from shutil import get_terminal_size
 import posixpath
 
 from xdg.BaseDirectory import xdg_config_home
+from sphinx.util.matching import patmatch
 
 from . import __version__
 from .config import Config
-from .cache import Cache
+from .cache import Cache, IndexID, Index
 from .table import tablify, COLUMNS
 
 DEFAULT_CONFIG_FILE = path.join(xdg_config_home, 'sphinxnotes', 'snippet', 'conf.py')
@@ -83,7 +84,14 @@ def main(argv: List[str] = sys.argv[1:]):
         help='list snippet indexes, columns of indexes: %s' % COLUMNS,
     )
     listparser.add_argument(
-        '--tags', '-t', type=str, default='*', help='list specified tags only'
+        '--tags', '-t', type=str, default='*', help='list snippets with specified tags'
+    )
+    listparser.add_argument(
+        '--docname',
+        '-d',
+        type=str,
+        default='**',
+        help='list snippets whose docname matches shell-style glob pattern',
     )
     listparser.add_argument(
         '--width',
@@ -205,9 +213,23 @@ def _on_command_stat(args: argparse.Namespace):
         print(f'\t {v} snippets(s)')
 
 
+def _filter_list_items(
+    cache: Cache, tags: str, docname_glob: str
+) -> Iterable[Tuple[IndexID, Index]]:
+    for index_id, index in cache.indexes.items():
+        # Filter by tags.
+        if index[0] not in tags and '*' not in tags:
+            continue
+        # Filter by docname.
+        (_, docname), _ = cache.index_id_to_doc_id[index_id]
+        if not patmatch(docname, docname_glob):
+            continue
+        yield (index_id, index)
+
+
 def _on_command_list(args: argparse.Namespace):
-    rows = tablify(args.cache.indexes, args.tags, args.width)
-    for row in rows:
+    items = _filter_list_items(args.cache, args.tags, args.docname)
+    for row in tablify(items, args.width):
         print(row)
 
 

src/sphinxnotes/snippet/integration/binding.sh

@@ -3,10 +3,10 @@
 #
 # :Author: Shengyu Zhang
 # :Date: 2021-08-14
-# :Version: 20211114
+# :Version: 20240828
 
 function snippet_view() {
-  selection=$(snippet_list ds)
+  selection=$(snippet_list --tags ds)
   [ -z "$selection" ] && return
 
   # Make sure we have $PAGER
@@ -22,14 +22,14 @@ function snippet_view() {
 }
 
 function snippet_edit() {
-  selection=$(snippet_list ds)
+  selection=$(snippet_list --tags ds)
   [ -z "$selection" ] && return
 
   echo "vim +\$($SNIPPET get --line-start $selection) \$($SNIPPET get --file $selection)"
 }
 
 function snippet_url() {
-  selection=$(snippet_list ds)
+  selection=$(snippet_list --tags ds)
   [ -z "$selection" ] && return
 
   echo "xdg-open \$($SNIPPET get --url $selection)"

src/sphinxnotes/snippet/integration/plugin.sh

@@ -3,15 +3,15 @@
 #
 # :Author: Shengyu Zhang
 # :Date: 2021-03-20
-# :Version: 20211114
+# :Version: 20240828
 
 # Make sure we have $SNIPPET
 [ -z "$SNIPPET"] && SNIPPET='snippet'
 
-# Arguments: $1: kinds
+# Arguments: $*: Extra opts of ``snippet list``
 # Returns: snippet_id
 function snippet_list() {
-  $SNIPPET list --tags $1 --width $(($(tput cols) - 2)) | \
+  $SNIPPET list --width $(($(tput cols) - 2)) "$@" | \
     fzf --with-nth 2..      \
         --no-hscroll        \
         --header-lines 1    \

src/sphinxnotes/snippet/integration/plugin.vim

@@ -13,6 +13,7 @@ function! s:SplitID(row)
   return split(a:row, ' ')[0]
 endfunction
 
+" TODO: extra opts
 function! g:SphinxNotesSnippetList(callback, tags)
   let l:width = 0.9
   let cmd = [s:snippet, 'list',

src/sphinxnotes/snippet/table.py

@@ -7,7 +7,7 @@
 """
 
 from __future__ import annotations
-from typing import Iterator, Dict
+from typing import Iterable, Tuple
 
 from .cache import Index, IndexID
 from .utils import ellipsis
@@ -17,8 +17,8 @@
 COLUMN_DELIMITER = '  '
 
 
-def tablify(indexes: Dict[IndexID, Index], tags: str, width: int) -> Iterator[str]:
-    """Create a table from sequence of cache.Index."""
+def tablify(indexes: Iterable[Tuple[IndexID, Index]], width: int) -> Iterable[str]:
+    """Create a table from sequence of indices"""
 
     # Calcuate width
     width = width
@@ -41,10 +41,8 @@ def tablify(indexes: Dict[IndexID, Index], tags: str, width: int) -> Iterator[st
     yield header
 
     # Write rows
-    for index_id, index in indexes.items():
+    for index_id, index in indexes:
         # TODO: assert index?
-        if index[0] not in tags and '*' not in tags:
-            continue
         row = COLUMN_DELIMITER.join(
             [
                 index_id,  # ID