tofix 1.0.0__py3-none-any.whl

tofix/__init__.py

@@ -0,0 +1,4 @@
+from tofix.core import Tofix, Format, Line
+from tofix.cli import app
+
+__all__ = ["Tofix", "Format", "Line", "app"]

tofix/cli.py

@@ -0,0 +1,29 @@
+from argparse import ArgumentParser
+from tofix import Tofix, Format
+import os
+
+
+def app():
+    parser = ArgumentParser()
+    parser.add_argument(
+        "--format",
+        choices=[Format.HUMAN, Format.MACHINE, Format.JSON],
+        default=Format.HUMAN,
+    )
+    parser.add_argument("--cached", action="store_true")
+    parser.add_argument("--unstaged", action="store_true")
+    args = parser.parse_args()
+
+    todos = Tofix(unstaged=args.unstaged, cached=args.cached)
+    _, lines = todos.files_and_lines()
+
+    if os.isatty(1) and args.format == Format.HUMAN:
+        Tofix.human_format(lines)
+    elif not os.isatty(1) or args.format == Format.MACHINE:
+        Tofix.machine_format(lines)
+    elif args.format == Format.JSON:
+        Tofix.json_format(lines)
+
+
+if __name__ == "__main__":
+    app()

tofix/core.py

@@ -0,0 +1,174 @@
+"""
+Implements the `todos` application. See `todos.Tofix` for more information.
+"""
+
+from dataclasses import dataclass
+from enum import Enum
+import os
+import json
+from typing import List, Optional, Any, Tuple, Dict
+from git import Git
+
+
+def _remove_nones(values: List[Optional[Any]]) -> List[Any]:
+    """Remove all None values from a list."""
+    return [v for v in values if v is not None]
+
+
+class Colors:
+    BOLD_GREEN = "\033[1;32m"
+    BOLD_YELLOW = "\033[1;33m"
+    RESET = "\033[0m"
+
+
+class Format(str, Enum):
+    """Formatting options for stdout."""
+
+    HUMAN = "human"
+    MACHINE = "machine"
+    JSON = "json"
+
+
+@dataclass
+class Line:
+    """Dataclass for a line containing the "todo" key."""
+
+    path: str
+    number: int
+    text: str
+
+    def to_dict(self):
+        """Represent as a dict."""
+        return {"file": self.path, "line": self.number, "text": self.text}
+
+
+class Tofix:
+    """Implements the `todos` application.
+
+    Exposes one method `files_and_lines` which returns a list of raw file paths and `Line`
+    objects for every line in the currently checked out branch that contains a specified
+    "todo" `key`.
+
+    Uses `gitpython` under the hood to run the necessary `git cherry` and `git diff`
+    commands.
+    """
+
+    base_branch: str
+    key: str
+    cached: bool
+    unstaged: bool
+    g: Git
+
+    def __init__(
+        self,
+        base_branch: str = "main",
+        key: str = "TODO",
+        cached: bool = False,
+        unstaged: bool = False,
+    ):
+        self.base_branch = base_branch
+        self.key = key
+        self.cached = cached
+        self.unstaged = unstaged
+        self.g = Git(os.getcwd())
+
+        if self.cached and self.unstaged:
+            raise ValueError("cached and unstaged are mutually exclusive options")
+
+    def _commits(self) -> List[str]:
+        # cherry outputs each commit that's in one branch but not the other
+        cherry_output = self.g.cherry(["-v", self.base_branch])
+        all_cherries = cherry_output.split("\n")
+
+        # git diff appends a "+ " in front of commits in the current branch that are not
+        # in the base branch"
+        added_cherries = [c for c in all_cherries if c[:2] == "+ "]
+
+        # there's a space between the "+" and the commit hash
+        hashes = [c.split(" ")[1] for c in added_cherries]
+        return hashes
+
+    def _files(self, left: str, right: Optional[str] = None) -> List[str]:
+        # Get names of files that changed in this commit range that have the key in them.
+        flags = ["--name-only", "-S", self.key]
+        if self.cached:
+            flags.append("--cached")
+        diff_args = _remove_nones([*flags, left, right])
+
+        diff_output = self.g.diff(diff_args)
+        files_with_keys = [line for line in diff_output.split("\n") if line != ""]
+        return files_with_keys
+
+    def _files_and_lines(
+        self, left: str, right: Optional[str]
+    ) -> Tuple[List[str], List[Line]]:
+        flags = ["-U999999"]
+        if self.cached:
+            flags.append("--cached")
+
+        paths = self._files(left, right)
+        result: List[Line] = []
+
+        for path in paths:
+            diff_args = _remove_nones([*flags, left, right, "--", path])
+            diff_output = self.g.diff(diff_args)
+
+            # ignore the first 6 lines, which display metadata
+            diff_lines = diff_output.split("\n")[6:]
+
+            # we need to figure out what the line number is for each added line
+            lines_with_key = [
+                Line(path=path, number=number, text=text[1:])
+                for number, text in enumerate(diff_lines)
+                if text[:1] == "+" and self.key in text
+            ]
+            result += lines_with_key
+
+        return paths, result
+
+    def files_and_lines(self) -> Tuple[List[str], List[Line]]:
+        """Return a list of `Line` objects for added line containing `self.key`."""
+        commits = self._commits()
+
+        # On the base branch there are no added commits, so nothing was introduced here.
+        if not commits:
+            return [], []
+
+        # We want to diff with the commit *before* the first one we added in our branch
+        left = f"{commits[0]}^"
+
+        # The right side of the diff should be empty unless we're only looking at
+        # committed files
+        right = None if self.cached or self.unstaged else commits[-1]
+
+        return self._files_and_lines(left, right)
+
+    @staticmethod
+    def _lines_by_path(lines: List[Line]) -> Dict[str, List[Line]]:
+        mapping = {}
+        for line in lines:
+            if mapping.get(line.path) is None:
+                mapping[line.path] = []
+            mapping[line.path].append(line)
+        return mapping
+
+    @classmethod
+    def human_format(cls, lines: List[Line]):
+        """Print the lines in a format comparable to that of `ack` and `ag`."""
+        for path, _lines in Tofix._lines_by_path(lines).items():
+            print(f"{Colors.BOLD_GREEN}{path}{Colors.RESET}")
+            for line in _lines:
+                print(f"{Colors.BOLD_YELLOW}{line.number}{Colors.RESET}: {line.text}")
+
+    @classmethod
+    def machine_format(cls, lines: List[Line]):
+        """Print the lines in a format consumable by `fpp`."""
+        for line in lines:
+            print(f"{line.path}:{line.number}:{line.text}")
+
+    @classmethod
+    def json_format(cls, lines: List[Line]):
+        """Print the lines as a json array to stdout."""
+        objects = [line.to_dict() for line in lines]
+        output = json.dumps(objects, indent=2)
+        print(output)

tofix-1.0.0.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: tofix
+Version: 1.0.0
+Summary: Find TODO and FIXME comments introduced on the current branch vs a base branch.
+Keywords: fixme,git,task,todo
+Author: Piper Maxine Baker
+Author-email: Piper Maxine Baker <dev@piper.community>
+License-Expression: MIT
+License-File: LICENSE.md
+Requires-Dist: gitpython>=3.1
+Maintainer: Piper Maxine Baker
+Maintainer-email: Piper Maxine Baker <dev@piper.community>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# `tofix`
+
+A tool to find all `TODO` and `FIXME` comments introduced on your dev branch. No more
+polluting your task list with those left by previous developers in the codebase. Just the
+changes *you* made.
+
+## usage
+
+Run `tofix` anywhere in a git repository while on a non-`main` branch. If outputting
+to a terminal, it gives a nice, human-readable format.
+
+```
+> tofix
+README.md
+7:TODO write an intro
+8:TODO write an outro
+todos.sh
+48:for file in $(git diff --name-only -S"TODO" "${earliest}^" $latest); do
+52: | grep "TODO" \
+```
+
+If piped to another command (e.g., [`fpp`](https://github.com/facebook/PathPicker)), it
+uses a machine-readable format:
+
+```
+> tofix | fpp
+README.md:7:TODO write an intro
+README.md:8:TODO write an outro
+todos.sh:48:for file in $(git diff --name-only -S"TODO" "${earliest}^" $latest); do
+todos.sh:52:        | grep "TODO" \
+
+________________________________________________________________________________________________________
+[f|A] selection, [down|j|up|k|space|b] navigation, [enter] open, [x] quick select mode, [c] command mode
+```
+
+Both of these formats are inspired by the output of
+[`ag`](https://github.com/mizuno-as/silversearcher-ag).
+
+## future work
+
+- [ ] `emacs` integration
+- [ ] `vscode` integration

tofix-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+tofix/__init__.py,sha256=7tkiTxRC0UNWR7Xe5Ny-plyrL-kVTiiC8FRaUeOPAm4,115
+tofix/cli.py,sha256=GtI7Xfm-QCzRA-FSSU5xs_kZO68aV5hdGS3yXrwZkns,805
+tofix/core.py,sha256=oPIU6Qbkebbfpd1Ps30n9K2kUXnYunl_2qinU62tx7k,5552
+tofix-1.0.0.dist-info/licenses/LICENSE.md,sha256=YVFy62PThcARSS5uQ3BVIZ7xnysxTxIsEC6-iP1QvvI,1090
+tofix-1.0.0.dist-info/WHEEL,sha256=jK0lbM7sVtq70msNoYotEXYS3OJMDdns2CRgyjhimnE,81
+tofix-1.0.0.dist-info/entry_points.txt,sha256=XD2wLLxe2a6h_SkVT0salPuVraazvn2GC9I3ROvAXCY,41
+tofix-1.0.0.dist-info/METADATA,sha256=xATQ40gQSGVJ8MfMW7xFF9cgijXWRKvyyF8hriUZ8Cc,1735
+tofix-1.0.0.dist-info/RECORD,,

tofix-1.0.0.dist-info/WHEEL

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

tofix-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+tofix = tofix.cli:app
+

tofix-1.0.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,19 @@
+# The MIT License (MIT)
+
+Copyright © 2026 Piper Maxine Baker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.