vim-eof-comment 0.3.12__tar.gz → 0.3.13__tar.gz

vim_eof_comment-0.3.13/.github/workflows/vim-eof-comment.yml

@@ -0,0 +1,40 @@
+# GitHub Actions example
+name: Run vim-eof-comment
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+    branches:
+      - main
+jobs:
+  vim_eof_comment:
+    name: vim-eof-comment
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6.1.0
+        with:
+          python-version: '3.10'
+      - name: Install pipenv
+        run: |
+          python -m pip install -U pip
+          pip install pipenv
+      - name: Install vim-eof-comment
+        run: |
+          pipenv install --dev vim-eof-comment
+      - name: Run vim-eof-comment
+        run: |
+          pipenv run vim-eof-comment -e lua,md,Makefile,yaml,toml -i lua:2:Y,md:2:Y -v .
+      - name: Auto Commit Changes
+        uses: stefanzweifel/git-auto-commit-action@v7.1.0
+        with:
+          commit_message: "chore: format files with `vim-eof-comment`"
+          commit_options: "--signoff"
+          branch: ${{ github.head_ref }}

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.3.12
+Version: 0.3.13
 Summary: Adds Vim EOF comments for given filetypes in given directories
 Author-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>
 Maintainer-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/pyproject.toml

@@ -47,7 +47,7 @@ maintainers = [{ name = "Guennadi Maximov C", email = "g.maxc.fox@protonmail.com
 name = "vim-eof-comment"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "0.3.12"
+version = "0.3.13"
 
     [project.scripts]
     vim-eof-comment = "vim_eof_comment.eof:main"

vim_eof_comment-0.3.13/version.txt

@@ -0,0 +1 @@
+0.3.13

vim_eof_comment-0.3.13/vim_eof_comment/args/completion.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
+"""
+Argument parsing completion utilities for ``vim-eof-comment``.
+
+Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
+"""
+__all__ = ["complete_parser"]
+
+from argparse import ArgumentParser
+from typing import List, NoReturn
+
+from argcomplete import autocomplete
+
+
+def complete_validator(completion_candidate: List[str], current_input: str) -> bool:
+    """
+    Complete non-prefix substring matches.
+
+    Parameters
+    ----------
+    completion_candidate : List[str]
+        All the completion candidates.
+    current_input : str
+        The current input string.
+
+    Returns
+    -------
+    bool
+        Whether the current input fits the completion candidates pool.
+    """
+    return current_input in completion_candidate
+
+
+def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
+    """
+    Complete the script argument parser.
+
+    Parameters
+    ----------
+    parser : argparse.ArgumentParser
+        The ``ArgumentParser`` object.
+    **kwargs
+        Extra parameters to be passed to ``argcomplete.autocomplete()``.
+    """
+    autocomplete(parser, validator=complete_validator, **kwargs)
+
+# vim: set ts=4 sts=4 sw=4 et ai si sta:

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment/args/completion.pyi

@@ -12,7 +12,7 @@ def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
     parser : argparse.ArgumentParser
         The ``ArgumentParser`` object.
     **kwargs
-        Extra parameters.
+        Extra parameters to be passed to ``argcomplete.autocomplete()``.
     """
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment/comments/generator.py

@@ -13,11 +13,20 @@ from io import TextIOWrapper
 from os.path import exists, isdir, realpath
 from typing import Dict, Iterator, List, NoReturn, Tuple
 
+from colorama import Fore, Style
+from colorama import init as color_init
+
 from ..types import IndentMap
 from ..util import die
 
 _JSON_FILE: str = realpath("./vim_eof_comment/comments/filetypes.json")
 
+_BLUE: int = Fore.BLUE
+_YELLOW: int = Fore.YELLOW
+_CYAN: int = Fore.CYAN
+_BRIGHT: int = Style.BRIGHT
+_RESET: int = Style.RESET_ALL
+
 
 def import_json() -> Tuple[Dict[str, str], Dict[str, IndentMap]]:
     """
@@ -195,15 +204,48 @@ class Comments():
         return comments.get(ext, None)
 
 
+def generate_list_items(ft: str, level: int, expandtab: str) -> str:
+    """
+    Generate a colored string for filetypes listing.
+
+    Parameters
+    ----------
+    ft : str
+        The filetype item in question.
+    level : int
+        Indent size.
+    expandtab : str
+        Either ``"Yes"`` or ``"No"``.
+
+    Returns
+    -------
+    str
+        The generated string.
+    """
+    txt = f"{_RESET}{_BRIGHT}{_BLUE}{ft}\n"
+    txt += f"   {_RESET}{_BRIGHT}indent size{_RESET}{_BRIGHT} ==> {_CYAN}{level}\n"
+    txt += f"   {_RESET}{_BRIGHT}expandtab{_RESET}{_BRIGHT} ==> {_CYAN}{expandtab}"
+
+    return txt
+
+
 def list_filetypes() -> NoReturn:
     """List all available filetypes."""
-    txt: List[str] = [""]
+    color_init()
+
+    defaults = Comments().get_defaults()
+    items: Dict[str, Tuple[int, str]] = dict()
+    for ft_ext, indents in defaults.items():
+        level: int = indents.get("level", 4)
+        et = "Yes" if indents.get("expandtab") else "No"
+        items[ft_ext] = (level, et)
+
+    keys: List[str] = list(items.keys())
+    keys.sort()
 
-    c: Comments = Comments()
-    defaults: Dict[str, IndentMap] = c.get_defaults()
-    for ext, indents in defaults.items():
-        txt.append(f"- {ext}: {indents}")
+    sorted_items: Dict[str, Tuple[int, str]] = {i: items[i] for i in keys}
 
+    txt = [generate_list_items(k, v[0], v[1]) for k, v in sorted_items.items()]
     die(*txt, code=0, sep="\n")
 
 

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment/eof.py

@@ -19,8 +19,8 @@ from .comments.generator import Comments, list_filetypes
 from .file import bootstrap_paths, get_last_line, modify_file, open_batch_paths
 from .regex import matches
 from .types import BatchPathDict, EOFCommentSearch, IndentHandler, IOWrapperBool
-from .util import die, gen_indent_maps, verbose_print, version_print
-from .version import __version__, list_versions
+from .util import die, gen_indent_maps, verbose_print
+from .version import __version__, list_versions, version_print
 
 _RED: int = Fore.LIGHTRED_EX
 _GREEN: int = Fore.LIGHTGREEN_EX

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment/util.py

@@ -5,7 +5,7 @@ EOF comments checker utilities.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["die", "error", "gen_indent_maps", "verbose_print", "version_print"]
+__all__ = ["die", "error", "gen_indent_maps", "verbose_print"]
 
 from sys import exit as Exit
 from sys import stderr, stdout
@@ -117,22 +117,6 @@ def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> NoReturn:
     print(*msg, end=end, sep=sep, flush=flush)
 
 
-def version_print(version: str) -> NoReturn:
-    """
-    Print project version, then exit.
-
-    Parameters
-    ----------
-    version : str
-        The version string.
-
-    See Also
-    --------
-    vim_eof_comment.util.die : The function used for this function.
-    """
-    die(f"vim-eof-comment-{version}", code=0)
-
-
 def gen_indent_maps(maps: List[IndentHandler]) -> Dict[str, IndentMap] | None:
     """
     Generate a dictionary from the custom indent maps.

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment/util.pyi

@@ -2,7 +2,7 @@ from typing import Callable, NoReturn, TextIO
 
 from .types import IndentHandler, IndentMap
 
-__all__ = ['die', 'error', 'gen_indent_maps', 'verbose_print', 'version_print']
+__all__ = ['die', 'error', 'gen_indent_maps', 'verbose_print']
 
 def error(*msg, **kwargs) -> NoReturn:
     """
@@ -77,19 +77,6 @@ def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> NoReturn:
     --------
     print : This function is essentially being wrapped around here.
     """
-def version_print(version: str) -> NoReturn:
-    """
-    Print project version, then exit.
-
-    Parameters
-    ----------
-    version : str
-        The version string.
-
-    See Also
-    --------
-    vim_eof_comment.util.die : The function used for this function.
-    """
 def gen_indent_maps(maps: list[IndentHandler]) -> dict[str, IndentMap] | None:
     """
     Generate a dictionary from the custom indent maps.

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment/version.py

@@ -5,7 +5,7 @@ Custom vim-eof-comment versioning objects.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["VersionInfo", "list_versions", "version_info", "__version__"]
+__all__ = ["VersionInfo", "list_versions", "version_info", "version_print", "__version__"]
 
 from typing import List, NoReturn, Tuple
 
@@ -103,7 +103,7 @@ class VersionInfo():
         Only one definition in constructor.
 
         >>> from vim_eof_comment.version import VersionInfo
-        >>> print(VersionInfo([(0, 0, 1)]))
+        >>> print(repr(VersionInfo([(0, 0, 1)])))
         0.0.1
 
         Multiple definitions in constructor.
@@ -163,7 +163,7 @@ class VersionInfo():
         return result
 
 
-version_info: VersionInfo = VersionInfo([
+version_info = VersionInfo([
     (0, 1, 1),
     (0, 1, 2),
     (0, 1, 3),
@@ -219,6 +219,7 @@ version_info: VersionInfo = VersionInfo([
     (0, 3, 10),
     (0, 3, 11),
     (0, 3, 12),
+    (0, 3, 13),
 ])
 
 __version__: str = str(version_info)
@@ -226,7 +227,18 @@ __version__: str = str(version_info)
 
 def list_versions() -> NoReturn:
     """List all versions."""
-    all_versions: str = version_info.get_all_versions()
-    die(all_versions, code=0)
+    die(version_info.get_all_versions(), code=0)
+
+
+def version_print(version: str) -> NoReturn:
+    """
+    Print project version, then exit.
+
+    Parameters
+    ----------
+    version : str
+        The version string.
+    """
+    die(f"vim-eof-comment-{version}", code=0)
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment/version.pyi

@@ -1,6 +1,8 @@
 from typing import NoReturn
 
-__all__ = ['VersionInfo', 'list_versions', 'version_info', '__version__']
+from _typeshed import Incomplete
+
+__all__ = ['VersionInfo', 'list_versions', 'version_info', 'version_print', '__version__']
 
 class VersionInfo:
     """
@@ -82,7 +84,7 @@ class VersionInfo:
         Only one definition in constructor.
 
         >>> from vim_eof_comment.version import VersionInfo
-        >>> print(VersionInfo([(0, 0, 1)]))
+        >>> print(repr(VersionInfo([(0, 0, 1)])))
         0.0.1
 
         Multiple definitions in constructor.
@@ -124,10 +126,19 @@ class VersionInfo:
         0.0.3 (latest)
         """
 
-version_info: VersionInfo
+version_info: Incomplete
 __version__: str
 
 def list_versions() -> NoReturn:
     """List all versions."""
+def version_print(version: str) -> NoReturn:
+    """
+    Print project version, then exit.
+
+    Parameters
+    ----------
+    version : str
+        The version string.
+    """
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.3.12
+Version: 0.3.13
 Summary: Adds Vim EOF comments for given filetypes in given directories
 Author-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>
 Maintainer-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>

{vim_eof_comment-0.3.12 → vim_eof_comment-0.3.13}/vim_eof_comment.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ version.txt
 .github/workflows/flake8-lint.yml
 .github/workflows/mypy-lint.yml
 .github/workflows/release.yml
+.github/workflows/vim-eof-comment.yml
 docs/Makefile
 docs/make.bat
 docs/source/conf.py

vim_eof_comment-0.3.12/version.txt

@@ -1 +0,0 @@
-0.3.12

vim_eof_comment-0.3.12/vim_eof_comment/args/completion.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
-"""
-Argument parsing completion utilities for ``vim-eof-comment``.
-
-Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
-"""
-__all__ = ["complete_parser"]
-
-from argparse import ArgumentParser
-from typing import NoReturn
-
-from argcomplete import autocomplete
-from argcomplete.finders import default_validator
-
-
-def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
-    """
-    Complete the script argument parser.
-
-    Parameters
-    ----------
-    parser : argparse.ArgumentParser
-        The ``ArgumentParser`` object.
-    **kwargs
-        Extra parameters.
-    """
-    autocomplete(parser, validator=default_validator, **kwargs)
-
-# vim: set ts=4 sts=4 sw=4 et ai si sta: