Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: set usage arguments and flags as environment variables for toml tasks #4159

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: set usage arguments and flags as environment variables for toml tasks #4159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4adb7c
feat: set usage arguments and flags as environment variables for toml…
gturi Jan 19, 2025
a80f287
[autofix.ci] apply automated fixes
autofix-ci[bot] Jan 19, 2025
a45c53c
test: add e2e test to verify that usage arguments and flags are set a…
gturi Feb 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions e2e/tasks/test_task_run_toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,26 @@ arg "myarg" "myarg description" default="foo"
run = 'echo {{arg(name="myarg")}}'
EOF
assert "mise run a" "foo"

cat <<'EOF' >mise.toml
[tasks.usage-env]
usage = '''
arg "myarg" "myarg description" default="foo"
'''
run = 'echo myarg=$usage_myarg'
EOF

assert "mise run usage-env" "myarg=foo"
assert "mise run usage-env bar" "myarg=bar"

cat <<'EOF' >mise.toml
[tasks.usage-env]
usage = '''
flag "-m --myflag <myflag>" default="foo"
'''
run = 'echo myflag=$usage_myflag'
EOF

assert "mise run usage-env" "myflag=foo"
assert "mise run usage-env -m bar" "myflag=bar"
assert "mise run usage-env --myflag bar" "myflag=bar"
30 changes: 22 additions & 8 deletions src/cli/run.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,6 +471,8 @@ impl Run {
for (script, args) in
task.render_run_scripts_with_args(self.cd.clone(), &task.args, &env)?
{
let get_args = || task.run.iter().chain(task.args.iter()).cloned().collect();
self.parse_usage_spec_and_init_env(task, &mut env, get_args)?;
self.exec_script(&script, &args, task, &env, &prefix)?;
}
}
Expand Down Expand Up @@ -585,14 +587,8 @@ impl Run {
let mut env = env.clone();
let command = file.to_string_lossy().to_string();
let args = task.args.iter().cloned().collect_vec();
let (spec, _) = task.parse_usage_spec(self.cd.clone(), &env)?;
if !spec.cmd.args.is_empty() || !spec.cmd.flags.is_empty() {
let args = once(command.clone()).chain(args.clone()).collect_vec();
let po = usage::parse(&spec, &args).map_err(|err| eyre!(err))?;
for (k, v) in po.as_env() {
env.insert(k, v);
}
}
let get_args = || once(command.clone()).chain(args.clone()).collect_vec();
self.parse_usage_spec_and_init_env(task, &mut env, get_args)?;

if !self.quiet(Some(task)) {
let cmd = format!("{} {}", display_path(file), args.join(" "))
Expand All @@ -606,6 +602,24 @@ impl Run {
self.exec(file, &args, task, &env, prefix)
}

fn parse_usage_spec_and_init_env(
&self,
task: &Task,
env: &mut EnvMap,
get_args: impl Fn() -> Vec<String>,
) -> Result<()> {
let (spec, _) = task.parse_usage_spec(self.cd.clone(), env)?;
if !spec.cmd.args.is_empty() || !spec.cmd.flags.is_empty() {
let args: Vec<String> = get_args();
let po = usage::parse(&spec, &args).map_err(|err| eyre!(err))?;
for (k, v) in po.as_env() {
env.insert(k, v);
}
}

Ok(())
}

fn exec(
&self,
file: &Path,
Expand Down