Todoctor
Логотип Todoctor
Todoctor вырос из рабочего проекта. В кодовой базе накопилось много TODO-комментариев, и хотелось понять, что с ними происходит: сколько их, как давно они лежат и становится ли их больше. Такие комментарии редко доходят до трекера задач и могут годами оставаться в коде.
Todoctor находит в JavaScript и TypeScript файлах комментарии с TODO, FIXME и похожими метками. Затем он проходит по истории Git и через git blame узнаёт, кто и когда оставил каждый комментарий.
Результат — HTML-отчёт, который сам открывается в браузере. В нём есть:
- график, как менялось число комментариев со временем;
- общее число комментариев, возраст самого старого и средний возраст;
- таблица со всеми комментариями, файлами и авторами.
Как выглядит отчёт, видно на примере.
Как начать его использовать?
Запустите Todoctor в корне репозитория:
Bash
npx todoctorСколько месяцев истории анализировать, задаёт флаг --months. Чтобы получить отчёт в JSON или CSV, используйте флаг --output-format.