Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jesperkha/todo
CLI tool for finding todo comments in codebases
https://github.com/jesperkha/todo
Last synced: 3 days ago
JSON representation
CLI tool for finding todo comments in codebases
- Host: GitHub
- URL: https://github.com/jesperkha/todo
- Owner: jesperkha
- License: mit
- Created: 2022-06-08T19:01:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-02T18:29:40.000Z (over 1 year ago)
- Last Synced: 2024-11-08T17:16:24.460Z (about 2 months ago)
- Language: Go
- Size: 14.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# todo
## Use:
By default, it will run with configuration set in `config.json`
```console
$ todo
┌── Todo ──────────────────────────────────────────────────────────────┐
│ │
│ 1. main.go:20 remove debug code after testing │
│ 2. other.go:6 include variable image sizes in export │
│ 3. test/test.go:68 add test cases for resizing and bordering │
│ │
└──────────────────────────────────────────────────────────────────────┘
```
Flags:
- `-r`: use relative paths (overrides config)
- `-d`: specify directory
- `-p`: specify prefix (overrides config)
- `-t`: print todos as raw text without formatting
Options:
- `--help`: display help info
- `--version`: print version
Example:
```console
$ todo -r -pTODO -dsome_dir
```
## Commands
### `rm`
Remove a todo from a file (removes the line the todo is located at). The list index is the number on the left of the list item when printing (starts at 1).
`todo rm `
## Config
You can add a `config.json` file in the same directory as the todo binary. If no config file is found then default options will be used. These are the config options you can put in you config file:
```js
// These are also the default values
{
"prefix": "Todo:",
// Max search depth
"depth": 5,
"relativePaths": false,
// Ignored file extensions (exe, png etc)
"ignoreFiles": [],
// Ignored directories (.vscode, .git etc)
"ignoreDirs": []
}
```