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
