vim-eof-comment 0.3.10__py3-none-any.whl → 0.3.12__py3-none-any.whl

docs/Makefile

@@ -0,0 +1,22 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     := source
+BUILDDIR      := build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# vim: set ts=4 sts=4 sw=0 noet ai si sta:

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""Runs configuration for building Sphinx documentation."""
+
+import sys
+from pathlib import Path
+from typing import List
+
+sys.path.insert(0, str(Path('..', 'src').resolve()))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project: str = 'vim-eof-comment'
+copyright: str = '2025, Guennadi Maximov C'
+author: str = 'Guennadi Maximov C'
+release: str = '0.1.33'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions: List[str] = [
+    'numpydoc',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.duration',
+]
+
+templates_path: List[str] = ['_templates']
+exclude_patterns: List[str] = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme: str = 'sphinx_rtd_theme'
+html_static_path: List[str] = ['_static']
+
+# -- Options for numpydoc ----------------------------------------------------
+numpydoc_xref_param_type = True
+numpydoc_validation_checks = {
+    "all",  # report on all checks, except the below
+    "ES01",
+    "EX01",
+    "SA01",
+}
+numpydoc_xref_aliases = {
+    'TextIO': 'typing.TextIO',
+    'List': 'list',
+    'Dict': 'dict',
+    'Tuple': 'tuple',
+}
+
+# vim: set ts=4 sts=4 sw=4 et ai si sta:

docs/source/functions.rst

@@ -0,0 +1,2 @@
+Functions
+=========

docs/source/index.rst

@@ -0,0 +1,22 @@
+vim-eof-comment
+===============
+
+**vim-eof-comment** is a Python script that adds Vim EOF comments for given filetypes in a directory.
+
+This tool adds a `Vim modeline comment <https://neovim.io/doc/user/options.html#_2.-automatically-setting-options>`_
+at the end of the target files.
+
+.. note::
+   This project is under active development.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Contents
+--------
+
+.. toctree::
+
+   installation
+   functions

docs/source/installation.rst

@@ -0,0 +1,14 @@
+Installation
+============
+
+To install *vim-eof-comment*, first install it using ``pip``:
+
+.. code-block:: console
+
+   $ pip install -U vim-eof-comment
+
+You may also use ``pipenv`` or any other virtual environment:
+
+.. code-block:: console
+
+   $ pipenv install vim-eof-comment

vim_eof_comment/__init__.py

@@ -6,6 +6,7 @@ Ensure EOF Vim comments.
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
 __all__ = [
+    "__version__",
     "args",
     "comments",
     "eof",
@@ -15,13 +16,10 @@ __all__ = [
     "types",
     "util",
     "version",
-    "version_info",
 ]
 
 from . import args, comments, eof, file, regex, types, util
 from .eof import main
-from .version import version_info
-
-version: str = str(version_info)
+from .version import __version__
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/__init__.pyi

@@ -6,10 +6,11 @@ from . import regex as regex
 from . import types as types
 from . import util as util
 from .eof import main as main
-from .version import version_info as version_info
+from .version import __version__ as __version__
 
-__all__ = ['args', 'comments', 'eof', 'file', 'main', 'regex', 'types', 'util', 'version', 'version_info']
+__all__ = ['__version__', 'args', 'comments', 'eof', 'file', 'main', 'regex', 'types', 'util', 'version']
 
-version: str
+# Names in __all__ with no definition:
+#   version
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/args/parsing.py

@@ -220,7 +220,7 @@ def indent_handler(indent: str) -> List[IndentHandler]:
         if len(inds) >= 3 and inds[2].upper() in ("Y", "N"):
             et = not inds[2].upper() == "N"
 
-        maps.append(IndentHandler(ext=ext, level=ind_level, expandtab=et))
+        maps.append(IndentHandler(ft_ext=ext, level=ind_level, expandtab=et))
 
     return maps
 

vim_eof_comment/comments/__init__.py

@@ -5,8 +5,8 @@ Comment class module for ``vim-eof-comment``.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["generator", "types"]
+__all__ = ["generator"]
 
-from . import generator, types
+from . import generator
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/comments/__init__.pyi

@@ -1,6 +1,5 @@
 from . import generator as generator
-from . import types as types
 
-__all__ = ['generator', 'types']
+__all__ = ['generator']
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/comments/filetypes.json

@@ -1 +1 @@
-[{"C": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "H": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "Makefile": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "bash": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "c": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "cc": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "cpp": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "css": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "fish": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "h": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "hh": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "hpp": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "htm": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "html": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "latex": "% vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "lua": "-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "markdown": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "md": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "mk": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "py": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "pyi": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "rb": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "sh": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "tex": "% vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "xml": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "zsh": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:"}, {"C": {"level": 2, "expandtab": true}, "H": {"level": 2, "expandtab": true}, "Makefile": {"level": 4, "expandtab": false}, "bash": {"level": 4, "expandtab": true}, "c": {"level": 2, "expandtab": true}, "cc": {"level": 2, "expandtab": true}, "cpp": {"level": 2, "expandtab": true}, "css": {"level": 4, "expandtab": true}, "fish": {"level": 4, "expandtab": true}, "h": {"level": 2, "expandtab": true}, "hh": {"level": 2, "expandtab": true}, "hpp": {"level": 2, "expandtab": true}, "htm": {"level": 2, "expandtab": true}, "html": {"level": 2, "expandtab": true}, "latex": {"level": 2, "expandtab": true}, "lua": {"level": 4, "expandtab": true}, "markdown": {"level": 2, "expandtab": true}, "md": {"level": 2, "expandtab": true}, "mk": {"level": 4, "expandtab": false}, "py": {"level": 4, "expandtab": true}, "pyi": {"level": 4, "expandtab": true}, "rb": {"level": 4, "expandtab": true}, "sh": {"level": 4, "expandtab": true}, "tex": {"level": 2, "expandtab": true}, "xml": {"level": 2, "expandtab": true}, "zsh": {"level": 4, "expandtab": true}}]
+[{ "C": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "H": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "Makefile": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "bash": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "c": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "cc": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "cpp": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "css": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "fish": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "h": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "hh": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "hpp": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "htm": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "html": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "javascript": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "javascriptreact": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "js": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "jsx": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "latex": "% vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "lua": "-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "make": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "markdown": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "md": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "mk": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "py": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "pyi": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "python": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "rb": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "rs": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "ruby": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "rust": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "sh": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "tex": "% vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "toml": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "ts": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "tsx": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "typescript": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "typescriptreact": "/* vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: */", "xhtml": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "xml": "<!-- vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta: -->", "yaml": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "yml": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:", "zsh": "# vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:" }, { "C": { "level": 2, "expandtab": true }, "H": { "level": 2, "expandtab": true }, "Makefile": { "level": 4, "expandtab": false }, "bash": { "level": 4, "expandtab": true }, "c": { "level": 2, "expandtab": true }, "cc": { "level": 2, "expandtab": true }, "cpp": { "level": 2, "expandtab": true }, "css": { "level": 4, "expandtab": true }, "fish": { "level": 4, "expandtab": true }, "h": { "level": 2, "expandtab": true }, "hh": { "level": 2, "expandtab": true }, "hpp": { "level": 2, "expandtab": true }, "htm": { "level": 2, "expandtab": true }, "html": { "level": 2, "expandtab": true }, "javascript": { "level": 4, "expandtab": true }, "javascriptreact": { "level": 4, "expandtab": true }, "js": { "level": 4, "expandtab": true }, "jsx": { "level": 4, "expandtab": true }, "latex": { "level": 2, "expandtab": true }, "lua": { "level": 4, "expandtab": true }, "make": { "level": 4, "expandtab": false }, "markdown": { "level": 2, "expandtab": true }, "md": { "level": 2, "expandtab": true }, "mk": { "level": 4, "expandtab": false }, "py": { "level": 4, "expandtab": true }, "pyi": { "level": 4, "expandtab": true }, "python": { "level": 4, "expandtab": true }, "rb": { "level": 2, "expandtab": true }, "rs": { "level": 4, "expandtab": true }, "ruby": { "level": 2, "expandtab": true }, "rust": { "level": 4, "expandtab": true }, "sh": { "level": 4, "expandtab": true }, "tex": { "level": 2, "expandtab": true }, "toml": { "level": 4, "expandtab": true }, "ts": { "level": 4, "expandtab": true }, "tsx": { "level": 4, "expandtab": true }, "typescript": { "level": 4, "expandtab": true }, "typescriptreact": { "level": 4, "expandtab": true }, "xhtml": { "level": 2, "expandtab": true }, "xml": { "level": 2, "expandtab": true }, "yaml": { "level": 2, "expandtab": true }, "yml": { "level": 2, "expandtab": true }, "zsh": { "level": 4, "expandtab": true } }]

vim_eof_comment/comments/generator.py

@@ -13,22 +13,22 @@ from io import TextIOWrapper
 from os.path import exists, isdir, realpath
 from typing import Dict, Iterator, List, NoReturn, Tuple
 
+from ..types import IndentMap
 from ..util import die
-from .types import GeneratedEOFComments, IndentMapDict
 
 _JSON_FILE: str = realpath("./vim_eof_comment/comments/filetypes.json")
 
 
-def import_json() -> Tuple[GeneratedEOFComments, IndentMapDict]:
+def import_json() -> Tuple[Dict[str, str], Dict[str, IndentMap]]:
     """
     Import default vars from JSON file.
 
     Returns
     -------
-    comments : GeneratedEOFComments
-        The default ``GeneratedEOFComments``.
-    map_dict : IndentMapDict
-        The default ``IndentMapDict``.
+    comments : Dict[str, str]
+        The default ``Dict[str, str]``.
+    map_dict : Dict[str, IndentMap]
+        The default indent mappings dict.
     """
     splitter: str = "/" if os.name != "nt" else "\\"
     split = __file__.split(splitter)
@@ -39,7 +39,7 @@ def import_json() -> Tuple[GeneratedEOFComments, IndentMapDict]:
     data: str = "".join(file.read().split("\n"))
     file.close()
 
-    result: Tuple[GeneratedEOFComments, IndentMapDict] = json.loads(data)
+    result: Tuple[Dict[str, str], Dict[str, IndentMap]] = json.loads(data)
 
     return result[0], result[1]
 
@@ -53,18 +53,18 @@ class Comments():
 
     Parameters
     ----------
-    mappings : IndentMapDict, optional, default=None
+    mappings : Dict[str, IndentMap], optional, default=None
         The ``str`` to ``IndentMap`` dictionary.
 
     Attributes
     ----------
-    __DEFAULT : IndentMapDict
+    __DEFAULT : Dict[str, IndentMap]
         The default/fallback alternative to ``langs``.
-    __formats : GeneratedEOFComments
+    __formats : Dict[str, str]
         The default/fallback alternative to ``comments``.
-    langs : IndentMapDict
+    langs : Dict[str, IndentMap]
         A dictionary of ``IndentMap`` type objects.
-    comments : GeneratedEOFComments
+    comments : Dict[str, str]
         A dictionary of file-extension-to-EOF-comment mappings.
 
     Methods
@@ -74,18 +74,18 @@ class Comments():
     get_defaults()
     """
 
-    __DEFAULT: IndentMapDict = _DEFAULT.copy()
-    __formats: GeneratedEOFComments = _formats.copy()
-    comments: GeneratedEOFComments
-    langs: IndentMapDict
+    __DEFAULT: Dict[str, IndentMap] = _DEFAULT.copy()
+    __formats: Dict[str, str] = _formats.copy()
+    comments: Dict[str, str]
+    langs: Dict[str, IndentMap]
 
-    def __init__(self, mappings: IndentMapDict | None = None):
+    def __init__(self, mappings: Dict[str, IndentMap] | None = None):
         """
         Create a new Vim EOF comment object.
 
         Parameters
         ----------
-        mappings : IndentMapDict, optional, default=None
+        mappings : Dict[str, IndentMap], optional, default=None
             The ``str`` to ``IndentMap`` dictionary.
         """
         if mappings is None or len(mappings) == 0:
@@ -126,13 +126,13 @@ class Comments():
         """
         return lang in self.__DEFAULT.keys()
 
-    def __fill_langs(self, langs: IndentMapDict) -> NoReturn:
+    def __fill_langs(self, langs: Dict[str, IndentMap]) -> NoReturn:
         """
         Fill languages dict.
 
         Parameters
         ----------
-        langs : IndentMapDict
+        langs : Dict[str, IndentMap]
             A dictionary of ``IndentMap`` type objects.
         """
         if len(langs) == 0:
@@ -142,26 +142,26 @@ class Comments():
         for lang, mapping in self.__DEFAULT.items():
             langs[lang] = langs.get(lang, mapping)
 
-        self.langs = IndentMapDict(**langs)
+        self.langs = langs.copy()
 
-    def get_defaults(self) -> IndentMapDict:
+    def get_defaults(self) -> Dict[str, IndentMap]:
         """
         Retrieve the default comment dictionary.
 
         Returns
         -------
-        IndentMapDict
+        Dict[str, IndentMap]
             A dictionary of ``IndentMap`` type objects.
         """
         return self.__DEFAULT
 
-    def generate(self) -> GeneratedEOFComments:
+    def generate(self) -> Dict[str, str]:
         """
         Generate the comments list.
 
         Returns
         -------
-        GeneratedEOFComments
+        Dict[str, str]
             The customly generated comments dictionary.
         """
         comments: Dict[str, str] = dict()
@@ -174,7 +174,7 @@ class Comments():
 
             comments[lang] = fmt.format(ts=lvl, sts=lvl, sw=sw, et=et)
 
-        self.comments: GeneratedEOFComments = GeneratedEOFComments(**comments)
+        self.comments: Dict[str, str] = comments.copy()
         return self.comments
 
     def get_ft(self, ext: str) -> str | None:
@@ -191,7 +191,7 @@ class Comments():
         str or None
             Either the file extension string, or if not available then ``None``.
         """
-        comments: GeneratedEOFComments = self.generate()
+        comments: Dict[str, str] = self.generate()
         return comments.get(ext, None)
 
 
@@ -200,7 +200,7 @@ def list_filetypes() -> NoReturn:
     txt: List[str] = [""]
 
     c: Comments = Comments()
-    defaults: IndentMapDict = c.get_defaults()
+    defaults: Dict[str, IndentMap] = c.get_defaults()
     for ext, indents in defaults.items():
         txt.append(f"- {ext}: {indents}")
 

vim_eof_comment/comments/generator.pyi

@@ -1,19 +1,19 @@
 from typing import Iterator, NoReturn
 
-from .types import GeneratedEOFComments, IndentMapDict
+from ..types import IndentMap
 
 __all__ = ['Comments', 'export_json', 'import_json', 'list_filetypes']
 
-def import_json() -> tuple[GeneratedEOFComments, IndentMapDict]:
+def import_json() -> tuple[dict[str, str], dict[str, IndentMap]]:
     """
     Import default vars from JSON file.
 
     Returns
     -------
-    comments : GeneratedEOFComments
-        The default ``GeneratedEOFComments``.
-    map_dict : IndentMapDict
-        The default ``IndentMapDict``.
+    comments : Dict[str, str]
+        The default ``Dict[str, str]``.
+    map_dict : Dict[str, IndentMap]
+        The default indent mappings dict.
     """
 
 class Comments:
@@ -22,18 +22,18 @@ class Comments:
 
     Parameters
     ----------
-    mappings : IndentMapDict, optional, default=None
+    mappings : Dict[str, IndentMap], optional, default=None
         The ``str`` to ``IndentMap`` dictionary.
 
     Attributes
     ----------
-    __DEFAULT : IndentMapDict
+    __DEFAULT : Dict[str, IndentMap]
         The default/fallback alternative to ``langs``.
-    __formats : GeneratedEOFComments
+    __formats : Dict[str, str]
         The default/fallback alternative to ``comments``.
-    langs : IndentMapDict
+    langs : Dict[str, IndentMap]
         A dictionary of ``IndentMap`` type objects.
-    comments : GeneratedEOFComments
+    comments : Dict[str, str]
         A dictionary of file-extension-to-EOF-comment mappings.
 
     Methods
@@ -42,17 +42,17 @@ class Comments:
     __fill_langs(langs)
     get_defaults()
     """
-    __DEFAULT: IndentMapDict
-    __formats: GeneratedEOFComments
-    comments: GeneratedEOFComments
-    langs: IndentMapDict
-    def __init__(self, mappings: IndentMapDict | None = None) -> None:
+    __DEFAULT: dict[str, IndentMap]
+    __formats: dict[str, str]
+    comments: dict[str, str]
+    langs: dict[str, IndentMap]
+    def __init__(self, mappings: dict[str, IndentMap] | None = None) -> None:
         """
         Create a new Vim EOF comment object.
 
         Parameters
         ----------
-        mappings : IndentMapDict, optional, default=None
+        mappings : Dict[str, IndentMap], optional, default=None
             The ``str`` to ``IndentMap`` dictionary.
         """
     def __iter__(self) -> Iterator[str]:
@@ -71,31 +71,31 @@ class Comments:
         bool
             Represents whether the file extension has been included in the defaults.
         """
-    def __fill_langs(self, langs: IndentMapDict) -> NoReturn:
+    def __fill_langs(self, langs: dict[str, IndentMap]) -> NoReturn:
         """
         Fill languages dict.
 
         Parameters
         ----------
-        langs : IndentMapDict
+        langs : Dict[str, IndentMap]
             A dictionary of ``IndentMap`` type objects.
         """
-    def get_defaults(self) -> IndentMapDict:
+    def get_defaults(self) -> dict[str, IndentMap]:
         """
         Retrieve the default comment dictionary.
 
         Returns
         -------
-        IndentMapDict
+        Dict[str, IndentMap]
             A dictionary of ``IndentMap`` type objects.
         """
-    def generate(self) -> GeneratedEOFComments:
+    def generate(self) -> dict[str, str]:
         """
         Generate the comments list.
 
         Returns
         -------
-        GeneratedEOFComments
+        Dict[str, str]
             The customly generated comments dictionary.
         """
     def get_ft(self, ext: str) -> str | None:

vim_eof_comment/eof.py

@@ -20,7 +20,7 @@ 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 list_versions, version_info
+from .version import __version__, list_versions
 
 _RED: int = Fore.LIGHTRED_EX
 _GREEN: int = Fore.LIGHTGREEN_EX
@@ -41,7 +41,7 @@ def eof_comment_search(
     files : Dict[str, BatchPathDict]
         A dictionary of ``str`` to ``BatchPathDict`` objects.
     comments : Comments
-        The ``Comments`` object containing the hardcoded comments per file extension.
+        The ``Comments`` object containing the hardcoded comments per file-type/file-extension.
     **kwargs
         COntains the ``verbose`` and ``newline`` boolean options.
 
@@ -68,7 +68,7 @@ def eof_comment_search(
     verbose_print(f"{_RESET}Analyzing files...\n", verbose=verbose)
     for path, file in files.items():
         file_obj: TextIOWrapper = file["file"]
-        ext: str = file["ext"]
+        ext: str = file["ft_ext"]
 
         wrapper = get_last_line(file_obj)
         last_line, has_nwl = wrapper["line"], wrapper["has_nwl"]
@@ -139,7 +139,7 @@ def main() -> int:
     parser, ns = arg_parser_init()
 
     if ns.version:
-        version_print(str(version_info))
+        version_print(__version__)
 
     if ns.list_fts:
         list_filetypes()
@@ -161,15 +161,12 @@ def main() -> int:
     if dry_run:
         verbose = True
 
-    indent = gen_indent_maps(indent.copy())
-
-    comments = Comments(indent)
-
     files = open_batch_paths(bootstrap_paths(dirs, exts))
     if len(files) == 0:
         code = 1 if not dry_run else 0
         die("No matching files found!", code=code)
 
+    comments = Comments(gen_indent_maps(indent.copy()))
     results = eof_comment_search(files, comments, verbose=verbose, newline=newline)
     if len(results) > 0 and not dry_run:
         append_eof_comment(results, comments, newline)

vim_eof_comment/eof.pyi

@@ -14,7 +14,7 @@ def eof_comment_search(files: dict[str, BatchPathDict], comments: Comments, **kw
     files : Dict[str, BatchPathDict]
         A dictionary of ``str`` to ``BatchPathDict`` objects.
     comments : Comments
-        The ``Comments`` object containing the hardcoded comments per file extension.
+        The ``Comments`` object containing the hardcoded comments per file-type/file-extension.
     **kwargs
         COntains the ``verbose`` and ``newline`` boolean options.
 

vim_eof_comment/file.py

@@ -44,7 +44,7 @@ def bootstrap_paths(paths: List[str], exts: List[str]) -> List[BatchPairDict]:
                     if not file.endswith(ext):
                         continue
 
-                    result.append(BatchPairDict(fpath=join(root, file), ext=ext))
+                    result.append(BatchPairDict(fpath=join(root, file), ft_ext=ext))
 
     return result
 
@@ -65,9 +65,9 @@ def open_batch_paths(paths: List[BatchPairDict]) -> Dict[str, BatchPathDict]:
     """
     result = dict()
     for path in paths:
-        fpath, ext = path["fpath"], path["ext"]
+        fpath, ext = path["fpath"], path["ft_ext"]
         try:
-            result[fpath] = {"file": open(fpath, "r"), "ext": ext}
+            result[fpath] = {"file": open(fpath, "r"), "ft_ext": ext}
         except KeyboardInterrupt:
             die("\nProgram interrupted!", code=1)  # Kills the program
         except FileNotFoundError:
@@ -89,7 +89,7 @@ def modify_file(file: TextIOWrapper, comments: Dict[str, str], ext: str, **kwarg
     comments : Dict[str, str]
         A filetype-to-comment dictionary.
     ext : str
-        The filetype extension given by the user.
+        The file-type/file-extension given by the user.
     **kwargs
         Contains the ``newline``, and ``matching`` boolean attributes.
 

vim_eof_comment/file.pyi

@@ -45,7 +45,7 @@ def modify_file(file: TextIOWrapper, comments: dict[str, str], ext: str, **kwarg
     comments : Dict[str, str]
         A filetype-to-comment dictionary.
     ext : str
-        The filetype extension given by the user.
+        The file-type/file-extension given by the user.
     **kwargs
         Contains the ``newline``, and ``matching`` boolean attributes.
 

vim_eof_comment/regex.py

@@ -11,7 +11,7 @@ from re import compile
 from typing import Tuple
 
 
-def matches(s: str, verbose: bool) -> bool:
+def matches(s: str, verbose: bool = False) -> bool:
     """
     Check if given string matches any of the given patterns.
 
@@ -19,7 +19,7 @@ def matches(s: str, verbose: bool) -> bool:
     ----------
     s : str
         The string to be matched.
-    verbose : bool
+    verbose : bool, optional, default=False
         Enables verbose mode.
 
     Returns

vim_eof_comment/regex.pyi

@@ -1,6 +1,6 @@
 __all__ = ['matches']
 
-def matches(s: str, verbose: bool) -> bool:
+def matches(s: str, verbose: bool = False) -> bool:
     """
     Check if given string matches any of the given patterns.
 
@@ -8,7 +8,7 @@ def matches(s: str, verbose: bool) -> bool:
     ----------
     s : str
         The string to be matched.
-    verbose : bool
+    verbose : bool, optional, default=False
         Enables verbose mode.
 
     Returns