package task import ( "fmt" "io" "log" "os" "sort" "strings" "text/tabwriter" "github.com/go-task/task/v3/internal/logger" "github.com/go-task/task/v3/taskfile" ) // ListTasksWithDesc reports tasks that have a description spec. func (e *Executor) ListTasksWithDesc() { e.printTasks(false) } // ListAllTasks reports all tasks, with or without a description spec. func (e *Executor) ListAllTasks() { e.printTasks(true) } func (e *Executor) printTasks(listAll bool) { var tasks []*taskfile.Task if listAll { tasks = e.allTaskNames() } else { tasks = e.tasksWithDesc() } if len(tasks) == 0 { if listAll { e.Logger.Outf(logger.Yellow, "task: No tasks available") } else { e.Logger.Outf(logger.Yellow, "task: No tasks with description available. Try --list-all to list all tasks") } return } e.Logger.Outf(logger.Default, "task: Available tasks for this project:") // Format in tab-separated columns with a tab stop of 8. w := tabwriter.NewWriter(e.Stdout, 0, 8, 0, '\t', 0) for _, task := range tasks { fmt.Fprintf(w, "* %s: \t%s\n", task.Name(), task.Desc) } w.Flush() } func (e *Executor) allTaskNames() (tasks []*taskfile.Task) { tasks = make([]*taskfile.Task, 0, len(e.Taskfile.Tasks)) for _, task := range e.Taskfile.Tasks { tasks = append(tasks, task) } sort.Slice(tasks, func(i, j int) bool { return tasks[i].Task < tasks[j].Task }) return } func (e *Executor) tasksWithDesc() (tasks []*taskfile.Task) { tasks = make([]*taskfile.Task, 0, len(e.Taskfile.Tasks)) for _, task := range e.Taskfile.Tasks { if task.Desc != "" { compiledTask, err := e.FastCompiledTask(taskfile.Call{Task: task.Task}) if err == nil { task = compiledTask } tasks = append(tasks, task) } } sort.Slice(tasks, func(i, j int) bool { return tasks[i].Task < tasks[j].Task }) return } // PrintTaskNames prints only the task names in a Taskfile. // Only tasks with a non-empty description are printed if allTasks is false. // Otherwise, all task names are printed. func (e *Executor) ListTaskNames(allTasks bool) { // if called from cmd/task.go, e.Taskfile has not yet been parsed if e.Taskfile == nil { if err := e.readTaskfile(); err != nil { log.Fatal(err) return } } // use stdout if no output defined var w io.Writer = os.Stdout if e.Stdout != nil { w = e.Stdout } // create a string slice from all map values (*taskfile.Task) s := make([]string, 0, len(e.Taskfile.Tasks)) for _, t := range e.Taskfile.Tasks { if allTasks || t.Desc != "" { s = append(s, strings.TrimRight(t.Task, ":")) } } // sort and print all task names sort.Strings(s) for _, t := range s { fmt.Fprintln(w, t) } }