vim-eof-comment 0.5.1__tar.gz → 0.5.3__tar.gz

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/.github/workflows/vim-eof-comment.yml

@@ -21,17 +21,14 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6.1.0
         with:
-          python-version: '3.13'
-      - name: Install pipenv
-        run: |
-          python -m pip install -U pip
-          pip install pipenv
+          python-version: '3.14'
       - name: Install vim-eof-comment
         run: |
-          pipenv install --dev vim-eof-comment
+          python -m pip install -U pip
+          pip install -U vim-eof-comment
       - name: Run vim-eof-comment
         run: |
-          pipenv run vim-eof-comment -e py,pyi,md,Makefile,yaml,toml -i py:4:Y,pyi:4:Y,md:2:Y -nv .
+          vim-eof-comment -e py,pyi,md,Makefile,yaml,toml -i py:4:Y,pyi:4:Y,md:2:Y -nv .
       - name: Auto Commit Changes
         uses: stefanzweifel/git-auto-commit-action@v7.1.0
         with:

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.5.1
+Version: 0.5.3
 Summary: Adds Vim EOF modeline 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.5.1 → vim_eof_comment-0.5.3}/pyproject.toml

@@ -40,7 +40,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.5.1"
+version = "0.5.3"
 
     [project.scripts]
     vim-eof-comment = "vim_eof_comment.eof:main"

vim_eof_comment-0.5.3/version.txt

@@ -0,0 +1 @@
+0.5.3

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment/eof.py

@@ -9,7 +9,7 @@ Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 __all__ = ["append_eof_comment", "eof_comment_search", "main"]
 
 from io import TextIOWrapper
-from typing import Dict, List, NoReturn
+from typing import Dict, List, NoReturn, Tuple
 
 from colorama import Fore, Style
 from colorama import init as color_init
@@ -32,7 +32,7 @@ def eof_comment_search(
     files: Dict[str, BatchPathDict],
     comments: Comments,
     **kwargs
-) -> Dict[str, EOFCommentSearch]:
+) -> Tuple[Dict[str, EOFCommentSearch], bool]:
     """
     Search through opened files.
 
@@ -71,7 +71,7 @@ def eof_comment_search(
         ext: str = file["ft_ext"]
 
         wrapper = get_last_line(file_obj)
-        last_line, had_nwl = wrapper["line"], wrapper["had_nwl"]
+        last_line, had_nwl, crlf = wrapper["line"], wrapper["had_nwl"], wrapper["crlf"]
 
         verbose_print(f"{_RESET} - {path} ==> ", verbose=verbose, end="", sep="")
         if last_line != comment_map[ext] or (newline and not had_nwl):
@@ -84,13 +84,14 @@ def eof_comment_search(
         else:
             verbose_print(f"{_BRIGHT}{_GREEN}OK", verbose=verbose)
 
-    return result
+    return result, crlf
 
 
 def append_eof_comment(
     files: Dict[str, EOFCommentSearch],
     comments: Comments,
-    newline: bool
+    newline: bool,
+    crlf: bool
 ) -> NoReturn:
     """
     Append a Vim EOF comment to files missing it.
@@ -103,6 +104,8 @@ def append_eof_comment(
         The ``Comments`` object containing the hardcoded comments per file extension.
     newline : bool
         Indicates whether a newline should be added before the comment.
+    crlf : bool
+        Whether the file is CRLF-terminated.
     """
     comment_map = comments.generate()
     for path, file in files.items():
@@ -117,12 +120,11 @@ def append_eof_comment(
             ext=ext,
             newline=newline,
             had_nwl=had_nwl,
-            matching=matching
+            matching=matching,
+            crlf=crlf
         )
-        file_obj = open(path, "w")
-
-        file_obj.write(txt)
-        file_obj.close()
+        with open(path, "w") as file_obj:
+            file_obj.write(txt)
 
 
 def main() -> int:
@@ -166,9 +168,9 @@ def main() -> int:
         die("No matching files found!", code=code)
 
     comments = Comments(gen_indent_maps(indent.copy()))
-    results = eof_comment_search(files, comments, verbose=verbose, newline=newline)
+    results, crlf = eof_comment_search(files, comments, verbose=verbose, newline=newline)
     if len(results) > 0 and not dry_run:
-        append_eof_comment(results, comments, newline)
+        append_eof_comment(results, comments, newline, crlf)
 
     return 0
 

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment/eof.pyi

@@ -5,7 +5,7 @@ from .types import BatchPathDict, EOFCommentSearch
 
 __all__ = ['append_eof_comment', 'eof_comment_search', 'main']
 
-def eof_comment_search(files: dict[str, BatchPathDict], comments: Comments, **kwargs) -> dict[str, EOFCommentSearch]:
+def eof_comment_search(files: dict[str, BatchPathDict], comments: Comments, **kwargs) -> tuple[dict[str, EOFCommentSearch], bool]:
     """
     Search through opened files.
 
@@ -30,7 +30,7 @@ def eof_comment_search(files: dict[str, BatchPathDict], comments: Comments, **kw
     vim_eof_comment.types.EOFCommentSearch
         The object type for the returning dictionary values.
     """
-def append_eof_comment(files: dict[str, EOFCommentSearch], comments: Comments, newline: bool) -> NoReturn:
+def append_eof_comment(files: dict[str, EOFCommentSearch], comments: Comments, newline: bool, crlf: bool) -> NoReturn:
     """
     Append a Vim EOF comment to files missing it.
 
@@ -42,6 +42,8 @@ def append_eof_comment(files: dict[str, EOFCommentSearch], comments: Comments, n
         The ``Comments`` object containing the hardcoded comments per file extension.
     newline : bool
         Indicates whether a newline should be added before the comment.
+    crlf : bool
+        Whether the file is CRLF-terminated.
     """
 def main() -> int:
     """

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment/file.py

@@ -137,7 +137,7 @@ def modify_file(file: TextIOWrapper, comments: Dict[str, str], ext: str, **kwarg
     ext : str
         The file-type/file-extension given by the user.
     **kwargs
-        Contains the ``newline``, and ``matching`` boolean attributes.
+        Contains the ``newline``, ``matching`` and ``crlf`` boolean attributes.
 
     Returns
     -------
@@ -146,25 +146,29 @@ def modify_file(file: TextIOWrapper, comments: Dict[str, str], ext: str, **kwarg
     """
     matching: bool = kwargs.get("matching", False)
     newline: bool = kwargs.get("newline", False)
+    crlf: bool = kwargs.get("crlf", False)
 
-    bdata: str = file.read()
-    data: List[str] = bdata.split("\n")
+    data: List[str] = file.read().split("\n")
     file.close()
 
-    data_len = len(data)
-    comment = comments[ext]
-    if data_len == 0:
-        data = [comment, ""]
-    elif data_len == 1:
+    if len(data) >= 1 and data[-1] != "":
+        data.append("")
+
+    if crlf:
+        data[-2] = ""
+
+    if len(data) == 0:
+        data = [comments[ext], ""]
+    elif len(data) == 1:
         if matching:
-            data = [comment, ""]
+            data = [comments[ext], ""]
         else:
-            data.insert(0, comment)
-    elif data_len >= 2:
+            data.insert(0, comments[ext])
+    elif len(data) >= 2:
         if matching:
-            data[-2] = comment
+            data[-2] = comments[ext]
         else:
-            data.insert(-1, comment)
+            data.insert(-1, comments[ext])
 
     if len(data) >= 3:
         if newline and data[-3] != "":
@@ -173,6 +177,9 @@ def modify_file(file: TextIOWrapper, comments: Dict[str, str], ext: str, **kwarg
         if not newline and data[-3] == "":
             data.pop(-3)
 
+    if crlf:
+        data.insert(-1, "\r")
+
     return "\n".join(data)
 
 
@@ -190,19 +197,25 @@ def get_last_line(file: TextIOWrapper) -> LineBool:
     LineBool
         An object containing both the last line in a string and a boolean indicating a newline.
     """
-    bdata: str = file.read()
-    data: List[str] = bdata.split("\n")
+    data: List[str] = file.read().split("\n")
     file.close()
 
-    had_newline, line = False, ""
-    if len(data) <= 1:
+    if data[-1] != "":
+        data.append("")
+
+    had_nwl, crlf, line = False, False, ""
+    if len(data) == 0:
+        line = ""
+    elif len(data) == 1:
         line = data[0]
     elif len(data) >= 2:
         line: str = data[-2]
+        if line == "\r":
+            line, crlf = "", True
 
         if len(data) >= 3:
-            had_newline = data[-3] == ""
+            had_nwl = data[-3] == ""
 
-    return LineBool(line=line, had_nwl=had_newline)
+    return LineBool(line=line, had_nwl=had_nwl, crlf=crlf)
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment/file.pyi

@@ -61,7 +61,7 @@ def modify_file(file: TextIOWrapper, comments: dict[str, str], ext: str, **kwarg
     ext : str
         The file-type/file-extension given by the user.
     **kwargs
-        Contains the ``newline``, and ``matching`` boolean attributes.
+        Contains the ``newline``, ``matching`` and ``crlf`` boolean attributes.
 
     Returns
     -------

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment/types.py

@@ -266,7 +266,7 @@ class IndentHandler(TypedDict):
 
 class IOWrapperBool(TypedDict):
     """
-    A dict containing ``file`` and ``had_nwl`` as keys.
+    A dict containing ``file``, ``had_nwl`` and ``crlf`` as keys.
 
     This is a ``TypedDict``-like object.
 
@@ -276,15 +276,18 @@ class IOWrapperBool(TypedDict):
         The opened file as a ``TextIO`` wrapper.
     had_nwl : bool
         Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
     """
 
     file: TextIO
     had_nwl: bool
+    crlf: bool
 
 
 class LineBool(TypedDict):
     """
-    A dict containing ``line`` and ``had_nwl`` as keys.
+    A dict containing ``line``, ``had_nwl`` and ``crlf`` as keys.
 
     This is a ``TypedDict``-like object.
 
@@ -294,10 +297,13 @@ class LineBool(TypedDict):
         The last line of the target file.
     had_nwl : bool
         Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
     """
 
     line: str
     had_nwl: bool
+    crlf: bool
 
 
 class BatchPathDict(TypedDict):

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment/types.pyi

@@ -208,7 +208,7 @@ class IndentHandler(TypedDict):
 
 class IOWrapperBool(TypedDict):
     """
-    A dict containing ``file`` and ``had_nwl`` as keys.
+    A dict containing ``file``, ``had_nwl`` and ``crlf`` as keys.
 
     This is a ``TypedDict``-like object.
 
@@ -218,13 +218,16 @@ class IOWrapperBool(TypedDict):
         The opened file as a ``TextIO`` wrapper.
     had_nwl : bool
         Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
     """
     file: TextIO
     had_nwl: bool
+    crlf: bool
 
 class LineBool(TypedDict):
     """
-    A dict containing ``line`` and ``had_nwl`` as keys.
+    A dict containing ``line``, ``had_nwl`` and ``crlf`` as keys.
 
     This is a ``TypedDict``-like object.
 
@@ -234,9 +237,12 @@ class LineBool(TypedDict):
         The last line of the target file.
     had_nwl : bool
         Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
     """
     line: str
     had_nwl: bool
+    crlf: bool
 
 class BatchPathDict(TypedDict):
     """

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment/version.py

@@ -82,6 +82,8 @@ version_info = VersionInfo([
     (0, 4, 2),
     (0, 5, 0),
     (0, 5, 1),
+    (0, 5, 2),
+    (0, 5, 3),
 ])
 
 __version__: str = str(version_info)

{vim_eof_comment-0.5.1 → vim_eof_comment-0.5.3}/vim_eof_comment.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.5.1
+Version: 0.5.3
 Summary: Adds Vim EOF modeline 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.5.1/version.txt

@@ -1 +0,0 @@
-0.5.1