Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asticode/go-astitodo
Parse TODOs in your GO code
https://github.com/asticode/go-astitodo
go golang todo
Last synced: 9 days ago
JSON representation
Parse TODOs in your GO code
- Host: GitHub
- URL: https://github.com/asticode/go-astitodo
- Owner: asticode
- License: mit
- Created: 2016-10-17T19:51:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T12:05:34.000Z (7 months ago)
- Last Synced: 2024-10-25T05:25:29.240Z (10 days ago)
- Topics: go, golang, todo
- Language: Go
- Homepage:
- Size: 30.3 KB
- Stars: 64
- Watchers: 5
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - go-astitodo - Parse TODOs in your GO code. (Utilities / Utility/Miscellaneous)
- awesome-go - go-astitodo - Parse TODOs in your GO code - ★ 40 (Utilities)
- awesome-go-extra - go-astitodo - 10-17T19:51:36Z|2020-08-17T22:56:15Z| (Utilities / Fail injection)
README
[](http://goreportcard.com/report/github.com/asticode/go-astitodo)
[](https://godoc.org/github.com/asticode/go-astitodo)
[](https://github.com/asticode/go-astitodo/actions/workflows/test.yml)
[](https://coveralls.io/github/asticode/go-astitodo)
This is a Golang library and CLI to parse TODOs in your GO code.
It parses the comments from the AST and extract their TODOs. It can provide valuable information such as the TODO's assignee which can be filtered afterwards.
Most IDEs allow parsing TODOs but they usually have problems with multi line TODOs, can't parse assignees, etc.
This is also a good start for people who want to use AST.
# Installation
Run
go get -u github.com/asticode/go-astitodo/...
# Usage
$ astitodo -h
Usage of astitodo:
-a string
Only TODOs assigned to this username(s) will be displayed
-e value
Path that will be excluded from the process
-f string
Format to use when outputting TODOs (supported formats: text, csv, json) (default "text")
-o string
Destination for output (can be stdout, stderr or a file) (default "stdout")
# Formatting
A todo is formatted this way:
```go
// TODO
//
// ...
```
You can also add an assignee:
```go
// TODO(this is the assignee)
```
# Examples
## Basic
Assume the following file:
```go
package mypackage
// TODO Damn this package seems useless
// Here is a dummy comment
// TODO(asticode) This variable should be dropped
var myvariable int
// TODO(username) This should be renamed
var oops bool
// TODO Damn this function should be rewritten
// Or maybe it should be dropped as well
func UselessFunction() {
var a = 1
a++
}
```
Running
go-astitodo
will give
Message: Damn this package seems useless
File: mypackage/main.go:3
Assignee: asticode
Message: This variable should be dropped
File: mypackage/main.go:6
Assignee: username
Message: This variable should be renamed
File: mypackage/main.go:9
Message: Damn this function should be rewritten
Or maybe it should be dropped as well
File: mypackage/main.go:12
## Filter by assignee
Running
go-astitodo -a asticode
will output
Assignee: asticode
Message: This variable should be dropped
File: mypackage/main.go:6
### Filter by multiple assignees
Running
astitodo -a user,anotheruser
will output
Assignee: asticode
Message: This variable should be dropped
File: mypackage/main.go:6
Assignee: username
Message: This variable should be renamed
File: mypackage/main.go:9
## Exclude paths
You can exclude paths by running
go-astitodo -e path/to/exclude/1 -e path/to/exclude/2
## Change output format
You can output CSV by running
go-astitodo -f csv
You can output JSON by running
$ astitodo -f json testdata/ | jq '[limit(1;.[])]'
```json
[
{
"Assignee": "",
"Filename": "testdata/excluded.go",
"Line": 3,
"Message": [
"This todo should be ignored as it is in the excluded path"
]
}
]
```
Use the `json` support to filter the data with `jq`, then use `text templating` to output `text` content.
astitodo -f json . | jq '.[] | select(.Assignee=="") | "\(.Filename):\(.Line): \(.Message[0])"'
"encoder.go:33: It does not escape separators from the encoded data."
...
## Output to a file
You can output to a file by running
go-astitodo -o
# Contributions
You know you want to =D