An open API service indexing awesome lists of open source software.

https://github.com/funnyhcat-dotcom/todo-md-dashboard

Generate a Markdown dashboard from TODO, FIXME, HACK, and NOTE comments.
https://github.com/funnyhcat-dotcom/todo-md-dashboard

cli code-quality dashboard developer-tools fixme markdown nodejs todo

Last synced: 26 days ago
JSON representation

Generate a Markdown dashboard from TODO, FIXME, HACK, and NOTE comments.

Awesome Lists containing this project

README

          

# todo-md-dashboard

Generate a Markdown dashboard from `TODO`, `FIXME`, `HACK`, and `NOTE` comments.

Use it to turn scattered code comments into a project maintenance board that can be committed as `TODO_DASHBOARD.md` or posted in a pull request.

## Quick start

```bash
npx todo-md-dashboard .
```

```bash
# write a dashboard
npx todo-md-dashboard . --output TODO_DASHBOARD.md

# JSON for automation
npx todo-md-dashboard src --format json

# include custom tags
npx todo-md-dashboard . --tag BUG --tag OPTIMIZE
```

## Detects

```js
// TODO(alice): add pagination
// FIXME: handle empty response
// HACK: temporary compatibility shim
// NOTE: public API shape is stable
```

## Output formats

- `markdown`
- `json`
- `text`

## License

MIT