Merge pull request #341 from dmur1/add-command-to-set-query-task-description-#332

add a command to set/query a task's description

Author: dmur1

README.md

@@ -203,7 +203,25 @@ the ctftime urls will be used to aid in the generation of writeups with the `wri
 
 ---
 
-### 🐋 <u>d</u>ocker
+### 🌹 <u>de</u>scription
+
+```
+$ ret description [task-description] 
+```
+
+set or query a task's description with ret
+
+supply no arguments to see the current description
+
+note that task metadata is stored in hidden directory `.ret` and therefore scoped to the cwd
+
+task metadata is stored in the `.ret/task.json` file
+
+🔗 https://github.com/rerrorctf/ret/blob/main/commands/description.go
+
+---
+
+### 🐋 <u>do</u>cker
 
 ```
 $ ret docker [ip] [port] 

commands/description.go

@@ -0,0 +1,63 @@
+package commands
+
+import (
+	"fmt"
+	"ret/config"
+	"ret/theme"
+	"ret/util"
+)
+
+func init() {
+	Commands = append(Commands, Command{
+		Name:  "description",
+		Emoji: "🌹", // a rose by any other name would smell as 1337
+		Func:  Description,
+		Help:  DescriptionHelp,
+		Arguments: []Argument{
+			{
+				Name:     "task-description",
+				Optional: true,
+				List:     false,
+			},
+		},
+		SeeAlso: nil})
+}
+
+func DescriptionHelp() string {
+	return "set or query a task's description with ret\n\n" +
+		"supply no arguments to see the current description\n\n" +
+		"note that task metadata is stored in hidden directory " + theme.ColorCyan + "`.ret`" + theme.ColorReset + " and therefore scoped to the cwd\n\n" +
+		"task metadata is stored in the " + theme.ColorCyan + "`" + config.TaskFileName + "`" + theme.ColorReset + " file\n"
+}
+
+func displayCurrentTaskDescription() {
+	description := util.GetCurrentTaskDescription()
+	if len(description) == 0 {
+		return
+	}
+
+	fmt.Printf("🌹 "+theme.ColorBlue+"%s"+theme.ColorReset+"\n", description)
+}
+
+func setCurrentTaskDescription(newDescription string) {
+	oldDescription := util.GetCurrentTaskDescription()
+
+	if len(oldDescription) > 0 {
+		fmt.Printf(theme.ColorGray+"🌹 changing description from: "+theme.ColorRed+"%s"+theme.ColorGray+" to: "+theme.ColorGreen+"%s"+theme.ColorReset+"\n", oldDescription, newDescription)
+	} else {
+		fmt.Printf(theme.ColorGray+"🌹 setting description to: "+theme.ColorGreen+"%s"+theme.ColorReset+"\n", newDescription)
+	}
+
+	util.SetCurrentTaskDescription(newDescription)
+}
+
+func Description(args []string) {
+	if len(args) == 0 {
+		displayCurrentTaskDescription()
+		return
+	}
+
+	util.EnsureSkeleton()
+
+	setCurrentTaskDescription(args[0])
+}

data/task.go

@@ -1,6 +1,7 @@
 package data
 
 type Task struct {
-	Name     string `json:"name"`
-	Category string `json:"category"`
+	Name        string `json:"name"`
+	Category    string `json:"category"`
+	Description string `json:"description"`
 }

util/task.go

@@ -58,3 +58,14 @@ func SetCurrentTaskCategory(category string) {
 	task.Category = category
 	SetCurrentTask(&task)
 }
+
+func GetCurrentTaskDescription() string {
+	task := GetCurrentTask()
+	return task.Description
+}
+
+func SetCurrentTaskDescription(description string) {
+	task := GetCurrentTask()
+	task.Description = description
+	SetCurrentTask(&task)
+}