Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felixge/taskpaper
This library implements the TaskPaper file format in Go.
https://github.com/felixge/taskpaper
Last synced: 3 days ago
JSON representation
This library implements the TaskPaper file format in Go.
- Host: GitHub
- URL: https://github.com/felixge/taskpaper
- Owner: felixge
- License: mit
- Created: 2018-11-14T17:00:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-16T14:09:43.000Z (about 6 years ago)
- Last Synced: 2024-12-18T05:44:16.022Z (7 days ago)
- Language: Go
- Homepage: https://www.taskpaper.com/
- Size: 14.6 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# taskpaper
This library implements the [TaskPaper](https://www.taskpaper.com/) file format
in [Go](https://golang.org/).
[](https://godoc.org/github.com/felixge/taskpaper)
[](https://travis-ci.org/felixge/taskpaper)
# Usage
Below is a short example program that parses TaskPaper document and shows
the resulting data structure:
```go
doc, _ := taskpaper.Unmarshal([]byte(strings.TrimSpace(`
My Project:
- Task A
- Task B
- Task C
Some note for Task C
`)))
data, _ := json.MarshalIndent(doc, "", " ")
fmt.Printf("%s\n", data)
```
```json
{
"Kind": "document",
"Children": [
{
"Kind": "project",
"Content": "My Project",
"Children": [
{
"Kind": "task",
"Content": "Task A",
"Children": [
{
"Kind": "task",
"Content": "Task B"
}
]
},
{
"Kind": "task",
"Content": "Task C",
"Children": [
{
"Kind": "note",
"Content": "Some note for Task C"
}
]
}
]
}
]
}
```
# File Format
Since there is only a [reference implementation](https://www.taskpaper.com/),
but no specification for the file format, I decided to define the TaskPaper
[ABNF](https://en.wikipedia.org/wiki/Augmented_Backus%E2%80%93Naur_form) that
is implemented by this library as follows:
```
; The last item has no trailing CR.
document = *(item CR) *1item
item = (task / project / note)
task = "- " content
project = content ":"
note = content
; The first tag needs no space in front of it, and the last tag doesn't need
; a space after it.
content = *1(tag " ") *(" " tag " " / OCTET) *1(" " tag)
; A tag name or value can be empty which is weird, but you can try it in
; TaskPaper.
tag = "@" tag_name *1("(" tag_value ")")
tag_name = *OCTET
tag_value = *OCTET
```