https://github.com/monomonedula/gopdd
Command line tool for collecting TODO markers from your code, known as Puzzle Driven Development (PDD)
https://github.com/monomonedula/gopdd
go golang management markers pdd puzzle todo
Last synced: about 2 months ago
JSON representation
Command line tool for collecting TODO markers from your code, known as Puzzle Driven Development (PDD)
- Host: GitHub
- URL: https://github.com/monomonedula/gopdd
- Owner: monomonedula
- License: mit
- Created: 2023-03-28T20:39:13.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-16T19:59:28.000Z (about 2 years ago)
- Last Synced: 2025-06-21T19:11:25.647Z (4 months ago)
- Topics: go, golang, management, markers, pdd, puzzle, todo
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoPdd
### PDD puzzle collector
A port of [the original PDD written in Ruby](https://github.com/cqfn/pdd/), but with JSON output and written in Go, so it compiles into a single pretty executable.
Expected formatting and most of the functionality is the same, so feel free to use documentation from the original repo for reference on how to write puzzles.
```
NAME:
GoPdd - Todo puzzle collector
USAGE:
GoPdd [global options] command [command options] [arguments...]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--source value, -s value Source directory to parse (default: ".")
--file value, -f value File to save JSON output into
--verbose, -v Enable verbose mode (a lot of logging) (default: false)
--skip-gitignore Don't look into .gitignore for excludes (default: false)
--skip-errors Suppress error as warning and skip badly formatted puzzles (default: false)
--rule value, -r value [ --rule value, -r value ] Rule to apply (can be used many times). Possible values: 'max-estimate:', 'min-estimate:', 'min-words:', 'available-roles:,...'
--include value, -n value [ --include value, -n value ] Glob pattern to include, e.g. "**/*.jpg"
--exclude value, -e value [ --exclude value, -e value ] Glob pattern to exclude, e.g. "**/*.jpg"
--help, -h show help
```
Example output:
```json
[
{
"id": "209-c992021",
"ticket": "209",
"estimate": 30,
"role": "DEV",
"lines": "3-5",
"body": "whatever 1234. Please fix soon 1.",
"file": "resources/foobar.py",
"author": "monomonedula",
"email": "email@xxx.xyz",
"time": "2023-03-26T23:27:31+03:00"
},
{
"id": "321-b7bbd66",
"ticket": "321",
"estimate": 60,
"role": "DEV",
"lines": "9-11",
"body": "very important issue. Please fix soon 2.",
"file": "resources/foobar.py",
"author": "monomonedula",
"email": "email@xxx.xyz",
"time": "2023-03-26T23:27:31+03:00"
}
]
```
Installation:
```
go install -v github.com/monomonedula/gopdd/cmd/gopdd@latest
```
Tested on MacOS and Linux.