Provide ValueHint to the command line options

Author: edomora97

src/opt.rs

@@ -1,7 +1,7 @@
 use std::path::PathBuf;
 
 use anyhow::{Context, Error};
-use clap::Parser;
+use clap::{Parser, ValueHint};
 use itertools::Itertools;
 
 use task_maker_dag::DagPriority;
@@ -64,7 +64,7 @@ pub struct LoggerOpt {
 #[derive(Parser, Debug, Clone)]
 pub struct FindTaskOpt {
     /// Directory of the task
-    #[clap(short = 't', long = "task-dir", default_value = "")]
+    #[clap(short = 't', long = "task-dir", default_value = "", value_hint = ValueHint::DirPath)]
     pub task_dir: PathBuf,
 
     /// Look at most for this number of parents for searching the task
@@ -117,7 +117,7 @@ pub struct ExecutionOpt {
     pub num_cores: Option<usize>,
 
     /// Run the evaluation on a remote server instead of locally
-    #[clap(long = "evaluate-on")]
+    #[clap(long = "evaluate-on", value_hint = ValueHint::Url)]
     pub evaluate_on: Option<String>,
 
     /// The name to use for the client in remote executions
@@ -133,7 +133,7 @@ pub struct ExecutionOpt {
 #[derive(Parser, Debug, Clone)]
 pub struct StorageOpt {
     /// Where to store the storage files, including the cache
-    #[clap(long = "store-dir")]
+    #[clap(long = "store-dir", value_hint = ValueHint::DirPath)]
     pub store_dir: Option<PathBuf>,
 
     /// Maximum size of the storage directory, in MiB
@@ -151,12 +151,13 @@ pub struct FilterOpt {
     ///
     /// Note that just the file name is checked (e.g. sol.cpp is the same as sol/sol.cpp). Without
     /// specifying anything all the solutions are executed.
+    #[clap(value_hint = ValueHint::FilePath)]
     pub filter: Vec<String>,
 
     /// Evaluate only the solution with the specified path
     ///
     /// The solution can reside anywhere in the filesystem.
-    #[clap(long, short)]
+    #[clap(long, short, value_hint = ValueHint::FilePath)]
     pub solution: Vec<PathBuf>,
 }
 

src/tools/booklet.rs

@@ -1,7 +1,7 @@
 use std::path::{Path, PathBuf};
 
 use anyhow::{bail, Context, Error};
-use clap::Parser;
+use clap::{Parser, ValueHint};
 
 use task_maker_format::ioi::{make_context_booklets, Booklet, BookletConfig, IOITask};
 use task_maker_format::{find_task, EvaluationConfig};
@@ -18,13 +18,13 @@ pub struct BookletOpt {
     /// Directory of the context.
     ///
     /// When specified, --task-dir should not be used.
-    #[clap(short = 'c', long = "contest-dir")]
+    #[clap(short = 'c', long = "contest-dir", value_hint = ValueHint::DirPath)]
     pub contest_dir: Option<PathBuf>,
 
     /// Directory of the task.
     ///
     /// When specified, --contest-dir should not be used.
-    #[clap(short = 't', long = "task-dir")]
+    #[clap(short = 't', long = "task-dir", value_hint = ValueHint::DirPath)]
     pub task_dir: Vec<PathBuf>,
 
     /// Look at most for this number of parents for searching the task

src/tools/fuzz_checker.rs

@@ -4,7 +4,7 @@ use std::path::{Path, PathBuf};
 use std::process::Stdio;
 
 use anyhow::{anyhow, bail, Context, Error};
-use clap::Parser;
+use clap::{Parser, ValueHint};
 use regex::Regex;
 use serde::Deserialize;
 
@@ -23,7 +23,7 @@ pub struct FuzzCheckerOpt {
     /// Where to store fuzzing data.
     ///
     /// The path is relative to the task directory.
-    #[clap(long, default_value = "fuzz")]
+    #[clap(long, default_value = "fuzz", value_hint = ValueHint::DirPath)]
     pub fuzz_dir: PathBuf,
 
     /// Additional sanitizers to use.

src/tools/gen_autocompletion.rs

@@ -4,13 +4,13 @@ use std::fs::File;
 use std::path::{Path, PathBuf};
 
 use anyhow::{Context, Error};
-use clap::{Command, CommandFactory, Parser};
+use clap::{Command, CommandFactory, Parser, ValueHint};
 use clap_complete::{Generator, Shell};
 
 #[derive(Parser, Debug)]
 pub struct GenAutocompletionOpt {
     /// Where to write the autocompletion files
-    #[clap(short = 't', long = "target")]
+    #[clap(short = 't', long = "target", value_hint = ValueHint::DirPath)]
     pub target: Option<PathBuf>,
 }
 

src/tools/sandbox.rs

@@ -3,7 +3,7 @@ use std::path::Path;
 use std::path::PathBuf;
 
 use anyhow::{Context, Error};
-use clap::Parser;
+use clap::{Parser, ValueHint};
 use tabox::configuration::SandboxConfiguration;
 use tabox::syscall_filter::SyscallFilter;
 use tabox::{Sandbox, SandboxImplementation};
@@ -14,11 +14,12 @@ use tempdir::TempDir;
 use task_maker_exec::sandbox::READABLE_DIRS;
 
 #[derive(Parser, Debug, Clone)]
+#[clap(trailing_var_arg = true)]
 pub struct SandboxOpt {
     /// Working directory of the sandbox.
     ///
     /// Will be mounted in /box inside the sandbox. Defaults to current working directory.
-    #[clap(long, short)]
+    #[clap(long, short, value_hint = ValueHint::DirPath)]
     pub workdir: Option<PathBuf>,
 
     /// Memory limit for the sandbox, in KiB.
@@ -34,7 +35,7 @@ pub struct SandboxOpt {
     pub single_process: bool,
 
     /// List of additional directory mounted read-only inside the sandbox.
-    #[clap(long, short)]
+    #[clap(long, short, value_hint = ValueHint::DirPath)]
     pub readable_dirs: Vec<PathBuf>,
 
     /// Mount /tmp and /dev/null inside the sandbox
@@ -50,6 +51,7 @@ pub struct SandboxOpt {
     pub gid: usize,
 
     /// Command to execute inside the sandbox. If not specified, bash is executed.
+    #[clap(multiple_values = true, value_hint = ValueHint::CommandWithArguments)]
     pub command: Vec<String>,
 }
 

src/tools/worker.rs

@@ -1,7 +1,7 @@
 use std::sync::Arc;
 
 use anyhow::{bail, Context, Error};
-use clap::Parser;
+use clap::{Parser, ValueHint};
 
 use task_maker_exec::executors::{RemoteEntityMessage, RemoteEntityMessageResponse};
 use task_maker_exec::Worker;
@@ -14,6 +14,7 @@ use crate::StorageOpt;
 #[derive(Parser, Debug, Clone)]
 pub struct WorkerOpt {
     /// Address to use to connect to a remote server
+    #[clap(value_hint = ValueHint::Url)]
     pub server_addr: String,
 
     /// ID of the worker (to differentiate between multiple workers on the same machine).