vim-eof-comment 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

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):
@@ -79,18 +79,19 @@ def eof_comment_search(
             result[path] = EOFCommentSearch(
                 state=IOWrapperBool(file=open(path, "r"), had_nwl=had_nwl),
                 lang=ext,
-                match=matches(last_line, verbose)
+                match=matches(last_line)
             )
         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():
@@ -166,9 +169,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/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/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,11 +146,15 @@ 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")
     file.close()
 
+    data: List[str] = bdata.split("\n")
+    if crlf:
+        data[-2] = ""
+
     data_len = len(data)
     comment = comments[ext]
     if data_len == 0:
@@ -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)
 
 
@@ -194,15 +201,22 @@ def get_last_line(file: TextIOWrapper) -> LineBool:
     data: List[str] = bdata.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/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/regex.py

@@ -7,11 +7,11 @@ Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
 __all__ = ["matches"]
 
-from re import compile
-from typing import Tuple
+from re import Pattern, compile
+from typing import AnyStr, List
 
 
-def matches(s: str, verbose: bool = False) -> bool:
+def matches(s: str) -> bool:
     """
     Check if given string matches any of the given patterns.
 
@@ -19,21 +19,18 @@ def matches(s: str, verbose: bool = False) -> bool:
     ----------
     s : str
         The string to be matched.
-    verbose : bool, optional, default=False
-        Enables verbose mode.
 
     Returns
     -------
     bool
         Whether the string matches the default regex.
     """
-    pats: Tuple[str, str] = (
-        "vim:([a-zA-Z]+(=[a-zA-Z0-9_]*)?:)+",
-        "vim:\\sset(\\s[a-zA-Z]+(=[a-zA-Z0-9_]*)?)*\\s[a-zA-Z]+(=[a-zA-Z0-9_]*)?:"
-    )
-    for pattern in [compile(pat) for pat in pats]:
-        match = pattern.search(s)
-        if match is not None:
+    pats: List[Pattern[AnyStr]] = [
+        compile("vim:([a-zA-Z]+(=[a-zA-Z0-9_]*)?:)+"),
+        compile("vim:\\sset(\\s[a-zA-Z]+(=[a-zA-Z0-9_]*)?)*\\s[a-zA-Z]+(=[a-zA-Z0-9_]*)?:"),
+    ]
+    for pattern in pats:
+        if pattern.search(s) is not None:
             return True
 
     return False

vim_eof_comment/regex.pyi

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

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/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/version.py

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

{vim_eof_comment-0.5.0.dist-info → vim_eof_comment-0.5.2.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.5.0
+Version: 0.5.2
 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>
 License-Expression: GPL-2.0-only
 Project-URL: Download, https://github.com/DrKJeff16/vim-eof-comment/releases/latest
+Project-URL: Funding, https://github.com/sponsors/DrKJeff16
 Project-URL: Issues, https://github.com/DrKJeff16/vim-eof-comment/issues
 Project-URL: Repository, https://github.com/DrKJeff16/vim-eof-comment
 Keywords: eof comments,eof,files,preprocessing,text,vim modeline,vim,vim-eof

{vim_eof_comment-0.5.0.dist-info → vim_eof_comment-0.5.2.dist-info}/RECORD

@@ -7,18 +7,18 @@ docs/source/installation.rst,sha256=PkiS3E_ujNTWeKXicZ7aBPch2l1R0TsRRL6pFj_oMJI,
 vim_eof_comment/__init__.py,sha256=ESbmhca9mTst3TYMer8zFw73IRsJvn5EESci_RpfLbQ,487
 vim_eof_comment/__init__.pyi,sha256=Eh8FQwE_F9TrQEiT7CR1mdGHBT6fHUzfV6VP8uSN33g,478
 vim_eof_comment/__main__.py,sha256=0AFVSkz8RuxSuPbJJWycyxs6u5Yypl8FKUMR3ZVLJbk,343
-vim_eof_comment/eof.py,sha256=3iCP_fL3aUrPndKve3DoSpikZSvyIR0kwaE46EAlJqA,5158
-vim_eof_comment/eof.pyi,sha256=BTw9brhrHBTX12fYuwfO8_D-Gyrf0387ErmgrcTdvh0,1786
-vim_eof_comment/file.py,sha256=HNtwUMteUeKldBcVJEjdxlHLWNDXPbgjswJ-9PKRlQA,5100
-vim_eof_comment/file.pyi,sha256=S02kb4Ta5kDXpC3fYAVboC89jSUzHv6AHoll5HMICUg,2265
+vim_eof_comment/eof.py,sha256=X2E-6yH45NbPK4kyWfa5nJyMeAHcs3vxinXea-sWrdo,5287
+vim_eof_comment/eof.pyi,sha256=eFaIkPQ3ZXS3CE6QpTEA9QCQmJpmG_5N3Kb3_Iz_tOo,1872
+vim_eof_comment/file.py,sha256=QGpj91dy7YgyCplVI52-eDZ6094-6FxSKYtAgjhX5Ok,5394
+vim_eof_comment/file.pyi,sha256=XOYsJnW72i7Zt9N0jSLpscls-ggzL08aQKXpxrLFiwY,2274
 vim_eof_comment/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vim_eof_comment/regex.py,sha256=rGfFIBMbfWlIxAScXqvgBlB-tMJBUxQwTVjEkoxDZ3o,1007
-vim_eof_comment/regex.pyi,sha256=LJt6HN9s0Vo1B5plpaYURVZ3okmtl5jnV6kKdn1KyqA,433
-vim_eof_comment/types.py,sha256=YumpVIUl1wxbn_QIEkWeUbxsa9b9RJYdVEBzx-Kt4xo,8195
-vim_eof_comment/types.pyi,sha256=r6QziOKE9nKaZ02TR1NZDWCtEcLtMCnsOqnDNXvXJfw,7083
+vim_eof_comment/regex.py,sha256=48oxUO3YDdM30U0qAsqyH_AycYCrcnaQ6cghy3NXHrw,903
+vim_eof_comment/regex.pyi,sha256=W0ZX_J9mLRckCdBNE-Bl09hsQ61VFqjuLwDlevEeeUM,336
+vim_eof_comment/types.py,sha256=kujXMK19J0Nngf6eoHyg04ZfD-WKAB_Cdna7uRVJTKQ,8367
+vim_eof_comment/types.pyi,sha256=OnXme5rgPq9vt8LHTRCSeOpkBAuc2J_7pcwcXFHOk1A,7255
 vim_eof_comment/util.py,sha256=MHLt-FJz4uhsa56J2sug74uqk6W3S0mVLugvz7KNRUU,4287
 vim_eof_comment/util.pyi,sha256=5RQukLgpVZTwbALhBOtd1NqFkiqC-V6JEWeT1_B9-2k,2675
-vim_eof_comment/version.py,sha256=TQzYqwQZB_r20lmzgs1-xwdDTAIin2dVYGP88Io2jUc,1883
+vim_eof_comment/version.py,sha256=OrehJsWieQkG3G4Wz8wj6ph5iZS7MAJ4PiILc-bnEM4,1913
 vim_eof_comment/version.pyi,sha256=P90IRWMKlsG_YU8G8a1e1eyTd8rC-6fUGvQrD3zjwbE,525
 vim_eof_comment/args/__init__.py,sha256=Hyqun15456NVFLAJ3cpdtuNEz5XaFH93vfVlbC-aeuc,318
 vim_eof_comment/args/__init__.pyi,sha256=cXK7nEpYBveD4kxtVTe2x8oUxT9mhENS5r3wK3AAX2U,151
@@ -31,9 +31,9 @@ vim_eof_comment/comments/__init__.pyi,sha256=cecbbrShh0If8btwJ8zKYpBt9dIsMwrDXbd
 vim_eof_comment/comments/filetypes.json,sha256=JpSrnBNO2AivLYi-C5--8yVocyBwye3IkMesNIz1uHA,2973
 vim_eof_comment/comments/generator.py,sha256=yuRvTuVd6qQ1ei496w8NQ0c1MR1e3qJHf1pOTalXlv8,7814
 vim_eof_comment/comments/generator.pyi,sha256=ue8oMa7yEoKfgQDJbeTzx0Qm5Wck2gHrDb_wF00xIyo,3687
-vim_eof_comment-0.5.0.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-vim_eof_comment-0.5.0.dist-info/METADATA,sha256=eri3jmB75CaTiK42raTS2kZSMUSWWyModjqc1v_Wp0o,2766
-vim_eof_comment-0.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-vim_eof_comment-0.5.0.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
-vim_eof_comment-0.5.0.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
-vim_eof_comment-0.5.0.dist-info/RECORD,,
+vim_eof_comment-0.5.2.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+vim_eof_comment-0.5.2.dist-info/METADATA,sha256=iXYWdGCwNRdaZ1vnU1bvfmEjMYGJmSPegdYTm7KbNPA,2826
+vim_eof_comment-0.5.2.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+vim_eof_comment-0.5.2.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
+vim_eof_comment-0.5.2.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
+vim_eof_comment-0.5.2.dist-info/RECORD,,

{vim_eof_comment-0.5.0.dist-info → vim_eof_comment-0.5.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: true
 Tag: py3-none-any