end-of-file-fixer 0.2.0__py3-none-any.whl

end_of_file_fixer/main.py

@@ -0,0 +1,86 @@
+import argparse
+import os
+import pathlib
+import sys
+from typing import IO
+
+import pathspec
+
+
+def _fix_file(file_obj: IO[bytes], check: bool) -> int:  # noqa: C901
+    # Test for newline at end of file
+    # Empty files will throw IOError here
+    try:
+        file_obj.seek(-1, os.SEEK_END)
+    except OSError:
+        return 0
+
+    last_character = file_obj.read(1)
+    # last_character will be '' for an empty file
+    if last_character not in {b"\n", b"\r"} and last_character != b"":
+        if not check:
+            # Needs this seek for windows, otherwise IOError
+            file_obj.seek(0, os.SEEK_END)
+            file_obj.write(b"\n")
+        return 1
+
+    while last_character in {b"\n", b"\r"}:
+        # Deal with the beginning of the file
+        if file_obj.tell() == 1:
+            if not check:
+                # If we've reached the beginning of the file and it is all
+                # linebreaks then we can make this file empty
+                file_obj.seek(0)
+                file_obj.truncate()
+            return 1
+
+        # Go back two bytes and read a character
+        file_obj.seek(-2, os.SEEK_CUR)
+        last_character = file_obj.read(1)
+
+    # Our current position is at the end of the file just before any amount of
+    # newlines.  If we find extraneous newlines, then backtrack and trim them.
+    position = file_obj.tell()
+    remaining = file_obj.read()
+    for sequence in (b"\n", b"\r\n", b"\r"):
+        if remaining == sequence:
+            return 0
+
+        if remaining.startswith(sequence):
+            if not check:
+                file_obj.seek(position + len(sequence))
+                file_obj.truncate()
+            return 1
+
+    return 0  # pragma: no cover
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument("path", help="path to directory", type=pathlib.Path)
+    parser.add_argument("--check", action="store_true")
+    args = parser.parse_args()
+
+    path: pathlib.Path = args.path
+    check: bool = args.check
+    gitignore_path = path / ".gitignore"
+
+    ignore_patterns = [
+        ".git",
+        ".cache",  # for uv cache
+    ]
+    if gitignore_path.exists():
+        with gitignore_path.open("r") as f:
+            ignore_patterns.extend(f.readlines())
+
+    gitignore_spec = pathspec.GitIgnoreSpec.from_lines(ignore_patterns)
+
+    retv = 0
+    for filename in gitignore_spec.match_tree(path, negate=True):
+        with pathlib.Path(filename).open("rb+") as f:
+            ret_for_file = _fix_file(f, check=check)
+            if ret_for_file:
+                sys.stdout.write(f"Fixing {filename}")
+            retv |= ret_for_file
+
+    return retv

end_of_file_fixer-0.2.0.dist-info/METADATA

@@ -0,0 +1,149 @@
+Metadata-Version: 2.3
+Name: end-of-file-fixer
+Version: 0.2.0
+Summary: A command-line tool that ensures all your text files end with exactly one newline character
+Keywords: python
+Author: community-of-python
+Classifier: Typing :: Typed
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pathspec
+Requires-Python: >=3.10, <4
+Project-URL: Changelogs, https://github.com/community-of-python/end-of-file-fixer/releases
+Project-URL: Issues, https://github.com/community-of-python/end-of-file-fixer/issues
+Project-URL: Repository, https://github.com/community-of-python/end-of-file-fixer
+Description-Content-Type: text/markdown
+
+# End Of File Fixer
+
+A command-line tool that ensures all your text files end with exactly one newline character.
+This tool helps maintain consistent file formatting across your codebase by automatically adding or removing trailing newlines as needed.
+
+## Why This Matters
+
+Many POSIX systems expect text files to end with a newline character. Having consistent line endings:
+- Prevents spurious diffs in version control
+- Ensures proper concatenation of files
+- Satisfies POSIX compliance
+- Improves readability in terminal environments
+
+## Features
+
+- Automatically adds a newline to files that don't end with one
+- Removes excess trailing newlines from files that have too many
+- Respects `.gitignore` patterns to avoid processing unwanted files
+- Works with all text file types
+- Cross-platform compatibility (Windows, macOS, Linux)
+- Dry-run mode to preview changes before applying them
+
+## Installation
+
+### Using uv
+
+```bash
+uv add end-of-file-fixer
+```
+
+### Using pip
+
+```bash
+pip install end-of-file-fixer
+```
+
+## Usage
+
+### Basic Usage
+
+To fix all files in the current directory and subdirectories:
+
+```bash
+end-of-file-fixer .
+```
+
+To check which files would be modified without making changes:
+
+```bash
+end-of-file-fixer . --check
+```
+
+## How It Works
+
+The end-of-file-fixer processes files in the following way:
+
+1. **Files with no trailing newline**: Adds exactly one newline at the end
+2. **Files with exactly one trailing newline**: Leaves unchanged
+3. **Files with multiple trailing newlines**: Truncates to exactly one newline
+4. **Empty files**: Left unchanged
+
+### Examples
+
+| Original File Content | After Processing |
+|----------------------|------------------|
+| `hello world`        | `hello world\n`  |
+| `hello world\n`      | `hello world\n`  |
+| `hello world\n\n\n`  | `hello world\n`  |
+| `` (empty file)      | `` (unchanged)   |
+
+## Configuration
+
+The tool automatically respects patterns in your `.gitignore` file, so it won't process files that are ignored by Git. Additionally, it always ignores:
+- `.git` directories
+- `.cache` directories (used by uv)
+
+## Exit Codes
+
+- `0`: No files needed fixing or all files were successfully fixed
+- `1`: Some files needed fixing (when using `--check` mode)
+
+## Development
+
+### Prerequisites
+
+- [uv](https://docs.astral.sh/uv/) for dependency management
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/community-of-python/end-of-file-fixer.git
+cd end-of-file-fixer
+
+# Install dependencies
+just install
+```
+
+### Running Tests
+
+```bash
+# Run tests
+just test
+```
+
+### Linting
+
+```bash
+# Run linting and formatting
+just lint
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Related Projects
+
+- [pre-commit](https://pre-commit.com/) - A framework for managing and maintaining multi-language pre-commit hooks
+- [editorconfig](https://editorconfig.org/) - Helps maintain consistent coding styles across different editors and IDEs

end_of_file_fixer-0.2.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+end_of_file_fixer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+end_of_file_fixer/main.py,sha256=hNOIMn1VnyOCrJxgD282oQf2ysPMWmC2CjU_tLIlAQY,2642
+end_of_file_fixer/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+end_of_file_fixer-0.2.0.dist-info/WHEEL,sha256=DpNsHFUm_gffZe1FgzmqwuqiuPC6Y-uBCzibcJcdupM,78
+end_of_file_fixer-0.2.0.dist-info/entry_points.txt,sha256=lWWJAZZZCdywSw18S88GIuafdBCnFgeepUtdioBUu4c,67
+end_of_file_fixer-0.2.0.dist-info/METADATA,sha256=247R_Rg8Pp50SDLLcNM7tN1A3UWegXfCa7YnScoToTQ,4169
+end_of_file_fixer-0.2.0.dist-info/RECORD,,

end_of_file_fixer-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.8
+Root-Is-Purelib: true
+Tag: py3-none-any

end_of_file_fixer-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+end-of-file-fixer = end_of_file_fixer.main:main
+