{"id":16661626,"url":"https://github.com/jml/difftodo","last_synced_at":"2025-03-16T23:31:40.819Z","repository":{"id":6928801,"uuid":"8179965","full_name":"jml/difftodo","owner":"jml","description":"Turns diffs into todo lists by parsing comments","archived":false,"fork":false,"pushed_at":"2021-01-16T09:56:59.000Z","size":147,"stargazers_count":31,"open_issues_count":11,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-27T15:18:44.880Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jml.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-02-13T13:50:39.000Z","updated_at":"2024-03-09T23:17:39.000Z","dependencies_parsed_at":"2022-09-15T15:33:15.672Z","dependency_job_id":null,"html_url":"https://github.com/jml/difftodo","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jml%2Fdifftodo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jml%2Fdifftodo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jml%2Fdifftodo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jml%2Fdifftodo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jml","download_url":"https://codeload.github.com/jml/difftodo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243835952,"owners_count":20355611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T10:35:40.198Z","updated_at":"2025-03-16T23:31:40.154Z","avatar_url":"https://github.com/jml.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# difftodo [![Build Status](https://travis-ci.org/jml/difftodo.svg)](https://travis-ci.org/jml/difftodo)\n\nDo you litter your code with `XXX`, `TODO`, and `FIXME` comments? Would you\nlike to actually _do_ those TODOs and _fix_ those FIXMEs? If so, `difftodo`\ncan help.\n\n`difftodo` finds all the comments you've edited or added that are marked with\n`XXX` or `TODO` and then displays the output in a nice, human-readable way.\n\n## How to use it\n\nFor most things, you just need to run `git todo`.\n\nIf you've got uncommitted, unstaged changes, `git todo` will show all TODOs\nfrom those changes.\n\nOtherwise, `git todo` will show all TODOs between your branch and `master`.\n\n### What do I need to do before merging this git branch?\n\n```\n$ git todo origin/master...\ngit-todo/Main.hs:62:\n  -- TODO: Take git diff flags as options\n\ngit-todo/Main.hs:73:\n  -- TODO: Read this as a bytestring from the start\n\ngit-todo/Main.hs:83:\n  -- TODO: Use gitlib\n```\n\n### What do I need to do before I can commit this?\n\n```\n$ git todo\ngit-todo/Main.hs:90:\n  -- TODO: Factor out todo reporting\n```\n\n### Have I staged any TODOs?\n\n```\n$ git todo --cached\n```\n\n### What TODOs are left in my code base?\n\n```\n$ git todo --files\n... too many to list here! ...\n```\n\n### Advanced usage\n\n`git todo` tries to do the right thing. If you want more control, then you can\nuse the `all-todos` command, which shows all of the TODOs found in a\nparticular file.\n\ne.g.\n\n```\n$ all-todos ../src-todo/branch-review.py\n../src-todo/branch-review.py:11:\n  # XXX: Incorporate this into difftodo\n```\n\nYou can also use `diff-todo` to extract TODOs from a diff. This is more or\nless how `git todo` works, so if you find yourself wanting a bit more control\nover what `git todo` does you can just use `diff-todo`, e.g.\n\n```\n$ git diff v1.0.1...v1.0.0 | diff-todo\n```\n\n## Installing\n\n### macOS\n\n```\n$ brew tap jml/difftodo\n$ brew install difftodo\n```\n\n### From source\n\nYou need to have the following dependencies installed before you can build:\n* `pcre`\n* `pkg-config`\n\nThe preferred method is to build\nusing [Stack](https://docs.haskellstack.org/en/stable/README/). In a checkout\nof the repository, run:\n\n```\n$ stack install\n```\n\nNote: the `git todo` command assumes that `git` is available on the `PATH`.\n\n## History\n\nThis was originally `bzr-todo`, and then became `difftodo`, and then got\nrewritten in Haskell.\n\n## Contributing\n\nI'm very keen to make this better, but I'm also rather busy. Patches \u0026 issues\nare welcome, but there's no SLA on replies.\n\nIf you find `difftodo` useful, then please let me know.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjml%2Fdifftodo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjml%2Fdifftodo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjml%2Fdifftodo/lists"}