docs: describe behavior of run --output better (jdx#3740)

miguelmig · Dec 21, 2024 · afca96a · afca96a
1 parent 6d10317
commit afca96a
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 5 deletions.
diff --git a/docs/cli/run.md b/docs/cli/run.md
@@ -89,7 +89,11 @@ Don't show extra output
 
 Don't show any output except for errors
 
-### `--output <OUTPUT>`
+### `-o --output <OUTPUT>`
+
+Change how tasks information is output when running tasks
+
+- `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors
 
 Examples:
 

diff --git a/docs/cli/tasks/run.md b/docs/cli/tasks/run.md
@@ -103,7 +103,11 @@ Don't show extra output
 
 Don't show any output except for errors
 
-### `--output <OUTPUT>`
+### `-o --output <OUTPUT>`
+
+Change how tasks information is output when running tasks
+
+- `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors
 
 Examples:
 

diff --git a/mise.usage.kdl b/mise.usage.kdl
@@ -1086,7 +1086,8 @@ The name of the script will be the name of the tasks.
     }
     flag "-q --quiet" help="Don't show extra output"
     flag "-S --silent" help="Don't show any output except for errors"
-    flag "--output" {
+    flag "-o --output" help="Change how tasks information is output when running tasks" {
+        long_help "Change how tasks information is output when running tasks\n\n- `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors"
         arg "<OUTPUT>"
     }
     mount run="mise tasks --usage"
@@ -1527,7 +1528,8 @@ The name of the script will be the name of the tasks.
         }
         flag "-q --quiet" help="Don't show extra output"
         flag "-S --silent" help="Don't show any output except for errors"
-        flag "--output" {
+        flag "-o --output" help="Change how tasks information is output when running tasks" {
+            long_help "Change how tasks information is output when running tasks\n\n- `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors"
             arg "<OUTPUT>"
         }
         arg "[TASK]" help="Tasks to run\nCan specify multiple tasks by separating with `:::`\ne.g.: mise run task1 arg1 arg2 ::: task2 arg1 arg2" required=false default="default"

diff --git a/src/cli/run.rs b/src/cli/run.rs
@@ -166,7 +166,13 @@ pub struct Run {
     #[clap(skip)]
     pub failed_tasks: Mutex<Vec<(Task, i32)>>,
 
-    #[clap(long)]
+    /// Change how tasks information is output when running tasks
+    ///
+    /// - `prefix` - Print stdout/stderr by line, prefixed with the task's label
+    /// - `interleave` - Print directly to stdout/stderr instead of by line
+    /// - `quiet` - Don't show extra output
+    /// - `silent` - Don't show any output including stdout and stderr from the task except for errors
+    #[clap(short, long, env = "MISE_TASK_OUTPUT")]
     pub output: Option<TaskOutput>,
 
     #[clap(skip)]

diff --git a/xtasks/fig/src/mise.ts b/xtasks/fig/src/mise.ts
@@ -2009,8 +2009,10 @@ const completionSpec: Fig.Spec = {
                 },
                 {
                     "name": [
+                        "-o",
                         "--output"
                     ],
+                    "description": "Change how tasks information is output when running tasks",
                     "isRepeatable": false,
                     "args": {
                         "name": "output",
@@ -2915,8 +2917,10 @@ const completionSpec: Fig.Spec = {
                         },
                         {
                             "name": [
+                                "-o",
                                 "--output"
                             ],
+                            "description": "Change how tasks information is output when running tasks",
                             "isRepeatable": false,
                             "args": {
                                 "name": "output",