github.com/monomonedula/gopdd@v1.2.1/README.md (about) 1 # GoPdd 2 3 ### PDD puzzle collector 4 5 6 7 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. 8 9 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. 10 11 ``` 12 NAME: 13 GoPdd - Todo puzzle collector 14 15 USAGE: 16 GoPdd [global options] command [command options] [arguments...] 17 18 COMMANDS: 19 help, h Shows a list of commands or help for one command 20 21 GLOBAL OPTIONS: 22 --source value, -s value Source directory to parse (default: ".") 23 --file value, -f value File to save JSON output into 24 --verbose, -v Enable verbose mode (a lot of logging) (default: false) 25 --skip-gitignore Don't look into .gitignore for excludes (default: false) 26 --skip-errors Suppress error as warning and skip badly formatted puzzles (default: false) 27 --rule value, -r value [ --rule value, -r value ] Rule to apply (can be used many times). Possible values: 'max-estimate:<int>', 'min-estimate:<int>', 'min-words:<int>', 'available-roles:<ROLENAME>,<ROLANME>...' 28 --include value, -n value [ --include value, -n value ] Glob pattern to include, e.g. "**/*.jpg" 29 --exclude value, -e value [ --exclude value, -e value ] Glob pattern to exclude, e.g. "**/*.jpg" 30 --help, -h show help 31 ``` 32 33 34 Example output: 35 ```json 36 [ 37 { 38 "id": "209-c992021", 39 "ticket": "209", 40 "estimate": 30, 41 "role": "DEV", 42 "lines": "3-5", 43 "body": "whatever 1234. Please fix soon 1.", 44 "file": "resources/foobar.py", 45 "author": "monomonedula", 46 "email": "email@xxx.xyz", 47 "time": "2023-03-26T23:27:31+03:00" 48 }, 49 { 50 "id": "321-b7bbd66", 51 "ticket": "321", 52 "estimate": 60, 53 "role": "DEV", 54 "lines": "9-11", 55 "body": "very important issue. Please fix soon 2.", 56 "file": "resources/foobar.py", 57 "author": "monomonedula", 58 "email": "email@xxx.xyz", 59 "time": "2023-03-26T23:27:31+03:00" 60 } 61 ] 62 ``` 63 64 Installation: 65 ``` 66 go install -v github.com/monomonedula/gopdd/cmd/gopdd@latest 67 ``` 68 69 Tested on MacOS and Linux. 70 71