https://github.com/rexim/todo
CLI tool for manipulating source code TODOs
https://github.com/rexim/todo
Last synced: about 1 year ago
JSON representation
CLI tool for manipulating source code TODOs
- Host: GitHub
- URL: https://github.com/rexim/todo
- Owner: rexim
- License: mit
- Created: 2017-07-03T05:22:20.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-04T20:26:18.000Z (over 8 years ago)
- Last Synced: 2025-04-18T00:56:48.139Z (about 1 year ago)
- Language: OCaml
- Size: 54.7 KB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Todo
CLI tool for manipulating source code TODOs
## Usage ##
```
Usage: todo [ --] [register --]
```
### Examples
```console
$ todo src/main.ml # show all TODOs in the src/main.ml file
$ todo $(git ls-files) # show all TODOs in the current git repo
$ todo 23 -- $(git ls-files) # find TODO(23) in the current git repo
$ todo register -- $(git ls-files) # for every ID-less TODO in git repo assign a random V4 UUID
```
## Build and Dev ##
```console
$ opam install oasis ounit uuidm batteries
$ ./configure --enable-tests
$ make
$ make test
$ make install
```
### NixOS Development Environment ###
We have `default.nix` for NixOS user, but **please, read default.nix
file before nix-shell-ing it!** It is not pure and it manipulates
`.opam/` in the home directory of the current user.
If you have better ideas on organizing the dev environment, feel free
to file an issue or a PR.
### NixOS overlay ###
To install the overlay just symlink the `overlay` folder to the
corresponding place:
```console
$ ln -s ./overlay ~/.config/nixpkgs/overlays/todo-overlay
$ nix-env -iA nixos.todo
```
## License ##
Copyright © 2017 Alexey Kutepov
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.