|
| 1 | +// Copyright 2024 The Jujutsu Authors |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +use crate::cli_util::CommandHelper; |
| 16 | +use crate::command_error::user_error; |
| 17 | +use crate::command_error::CommandError; |
| 18 | +use crate::ui::Ui; |
| 19 | + |
| 20 | +/// Execute an external command via jj |
| 21 | +/// |
| 22 | +/// This is useful for arbitrary aliases. |
| 23 | +/// |
| 24 | +/// !! WARNING !! |
| 25 | +/// |
| 26 | +/// The following technique just provides a convenient syntax for running |
| 27 | +/// arbitrary code on your system. Using it irresponsibly may cause damage |
| 28 | +/// ranging from breaking the behavior of `jj undo` to wiping your file system. |
| 29 | +/// Exercise the same amount of caution while writing these aliases as you would |
| 30 | +/// when typing commands into the terminal! |
| 31 | +/// |
| 32 | +/// This feature may be removed entirely in the future. It may be replaced by |
| 33 | +/// an embedded scripting language with limited capabilities for safety. |
| 34 | +/// |
| 35 | +/// Let's assume you have a script called "my-jj-script" in you $PATH and you |
| 36 | +/// would like to execute it as "jj my-script". You would add the following line |
| 37 | +/// to your configuration file to achieve that: |
| 38 | +/// |
| 39 | +/// ```toml |
| 40 | +/// [aliases] |
| 41 | +/// my-script = ["util", "exec", "--", "my-jj-script"] |
| 42 | +/// # ^^^^ |
| 43 | +/// # This makes sure that flags are passed to your script instead of parsed by jj. |
| 44 | +/// ``` |
| 45 | +/// |
| 46 | +/// If you don't want to manage your script as a separate file, you can even |
| 47 | +/// inline it into your config file: |
| 48 | +/// |
| 49 | +/// ```toml |
| 50 | +/// [aliases] |
| 51 | +/// my-inline-script = ["util", "exec", "--", "bash", "-c", """ |
| 52 | +/// #!/usr/bin/env bash |
| 53 | +/// set -euo pipefail |
| 54 | +/// echo "Look Ma, everything in one file!" |
| 55 | +/// echo "args: $@" |
| 56 | +/// """, ""] |
| 57 | +/// # ^^ |
| 58 | +/// # This last empty string will become "$0" in bash, so your actual arguments |
| 59 | +/// # are all included in "$@" and start at "$1" as expected. |
| 60 | +/// ``` |
| 61 | +#[derive(clap::Args, Clone, Debug)] |
| 62 | +#[command(verbatim_doc_comment)] |
| 63 | +pub(crate) struct UtilExecArgs { |
| 64 | + /// External command to execute |
| 65 | + command: String, |
| 66 | + /// Arguments to pass to the external command |
| 67 | + args: Vec<String>, |
| 68 | +} |
| 69 | + |
| 70 | +pub fn cmd_util_exec( |
| 71 | + _ui: &mut Ui, |
| 72 | + _command: &CommandHelper, |
| 73 | + args: &UtilExecArgs, |
| 74 | +) -> Result<(), CommandError> { |
| 75 | + let status = std::process::Command::new(&args.command) |
| 76 | + .args(&args.args) |
| 77 | + .status() |
| 78 | + .map_err(user_error)?; |
| 79 | + if !status.success() { |
| 80 | + let error_msg = if let Some(exit_code) = status.code() { |
| 81 | + format!("External command exited with {exit_code}") |
| 82 | + } else { |
| 83 | + "External command was terminated by signal".into() |
| 84 | + }; |
| 85 | + return Err(user_error(error_msg)); |
| 86 | + } |
| 87 | + Ok(()) |
| 88 | +} |
0 commit comments