1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
/*!
# About
The `sprint` crate provides the [`Shell`] struct which represents a shell
session in your library or CLI code and can be used for running commands:
* [Show the output](#run-commands-and-show-the-output)
* [Return the output](#run-commands-and-return-the-output)
[`Shell`] exposes its properties so you can easily
[create a custom shell](#customize) or [modify an existing shell](#modify) with
the settings you want.
[`Shell`]: https://docs.rs/sprint/latest/sprint/struct.Shell.html
# Examples
## Run command(s) and show the output
~~~rust
use sprint::*;
let shell = Shell::default();
shell.run(&[Command::new("ls"), Command::new("ls -l")]);
// or equivalently:
//shell.run_str(&["ls", "ls -l"]);
~~~
## Run command(s) and return the output
~~~rust
use sprint::*;
let shell = Shell::default();
let results = shell.run(&[Command {
command: String::from("ls"),
stdout: Pipe::string(),
codes: vec![0],
..Default::default()
}]);
assert_eq!(
results[0].stdout,
Pipe::String(Some(String::from("\
Cargo.lock
Cargo.toml
CHANGELOG.md
Makefile.md
README.md
src
t
target
tests
\
"))),
);
~~~
## Customize
~~~rust
use sprint::*;
let shell = Shell {
shell: Some(String::from("sh -c")),
dry_run: false,
sync: true,
print: true,
fence: String::from("```"),
info: String::from("text"),
prompt: String::from("$ "),
fence_color: bunt::style!("#555555"),
info_color: bunt::style!("#555555"),
prompt_color: bunt::style!("#555555"),
command_color: bunt::style!("#00ffff+bold"),
error_color: bunt::style!("#ff0000+bold+italic"),
};
shell.run(&[Command::new("ls"), Command::new("ls -l")]);
~~~
## Modify
~~~rust
use sprint::*;
let mut shell = Shell::default();
shell.shell = None;
shell.run(&[Command::new("ls"), Command::new("ls -l")]);
shell.sync = false;
shell.run(&[Command::new("ls"), Command::new("ls -l")]);
~~~
*/
//--------------------------------------------------------------------------------------------------
use bunt::termcolor::{ColorChoice, ColorSpec, StandardStream, WriteColor};
use rayon::prelude::*;
use std::io::{IsTerminal, Read, Write};
//--------------------------------------------------------------------------------------------------
/**
Get stdout as a [`StandardStream`]
*/
pub fn get_stdout() -> StandardStream {
StandardStream::stdout(if std::io::stdout().is_terminal() {
ColorChoice::Auto
} else {
ColorChoice::Never
})
}
/**
Clear the color style
*/
pub fn reset_stdout() {
let mut stdout = get_stdout();
stdout.reset().unwrap();
stdout.flush().unwrap();
}
macro_rules! cprint {
($color:expr, $($x:tt)*) => {
let mut stdout = get_stdout();
stdout.set_color($color).unwrap();
write!(&mut stdout, $($x)*).unwrap();
stdout.reset().unwrap();
stdout.flush().unwrap();
};
}
macro_rules! cprintln {
($color:expr, $($x:tt)*) => {
let mut stdout = get_stdout();
stdout.set_color($color).unwrap();
write!(&mut stdout, $($x)*).unwrap();
stdout.reset().unwrap();
writeln!(&mut stdout).unwrap();
stdout.flush().unwrap();
};
}
//--------------------------------------------------------------------------------------------------
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Pipe {
Null,
Stdout,
Stderr,
String(Option<String>),
}
impl Pipe {
pub fn string() -> Pipe {
Pipe::String(None)
}
}
//--------------------------------------------------------------------------------------------------
/**
Command runner
*Please see also the module-level documentation for a high-level description and examples.*
```
use sprint::*;
// Use the default configuration:
let shell = Shell::default();
// Or a custom configuration:
let shell = Shell {
shell: Some(String::from("sh -c")),
//shell: Some(String::from("bash -c")), // Use bash
//shell: Some(String::from("bash -xeo pipefail -c")), // Use bash w/ options
//shell: None, // Run directly instead of a shell
dry_run: false,
sync: true,
print: true,
fence: String::from("```"),
info: String::from("text"),
prompt: String::from("$ "),
fence_color: bunt::style!("#555555"),
info_color: bunt::style!("#555555"),
prompt_color: bunt::style!("#555555"),
command_color: bunt::style!("#00ffff+bold"),
error_color: bunt::style!("#ff0000+bold+italic"),
};
// Or modify it on the fly:
let mut shell = Shell::default();
shell.shell = None;
shell.sync = false;
// ...
```
*/
#[derive(Clone, Debug)]
pub struct Shell {
pub shell: Option<String>,
pub dry_run: bool,
pub sync: bool,
pub print: bool,
pub fence: String,
pub info: String,
pub prompt: String,
pub fence_color: ColorSpec,
pub info_color: ColorSpec,
pub prompt_color: ColorSpec,
pub command_color: ColorSpec,
pub error_color: ColorSpec,
}
impl Default for Shell {
/**
Default [`Shell`]
*/
fn default() -> Shell {
Shell {
shell: Some(String::from("sh -c")),
dry_run: false,
sync: true,
print: true,
fence: String::from("```"),
info: String::from("text"),
prompt: String::from("$ "),
fence_color: bunt::style!("#555555"),
info_color: bunt::style!("#555555"),
prompt_color: bunt::style!("#555555"),
command_color: bunt::style!("#00ffff+bold"),
error_color: bunt::style!("#ff0000+bold+italic"),
}
}
}
impl Shell {
/**
Run command(s)
*/
pub fn run(&self, commands: &[Command]) -> Vec<Command> {
if self.sync {
if self.print {
cprint!(&self.fence_color, "{}", self.fence);
cprintln!(&self.info_color, "{}", self.info);
}
let mut r = vec![];
let mut error = None;
for (i, command) in commands.iter().enumerate() {
if i > 0 && self.print && !self.dry_run {
bunt::println!("");
}
let result = self.run1(command);
if let Some(code) = &result.code {
if !result.codes.contains(code) {
error = Some(format!(
"**Command `{}` exited with code: `{code}`!**",
result.command,
));
}
} else if !self.dry_run {
error = Some(format!(
"**Command `{}` was killed by a signal!**",
result.command,
));
}
r.push(result);
if error.is_some() {
break;
}
}
if self.print {
cprintln!(&self.fence_color, "{}\n", self.fence);
if let Some(error) = error {
cprintln!(&self.error_color, "{}\n", error);
}
}
r
} else {
commands
.par_iter()
.map(|command| self.run1(command))
.collect()
}
}
/**
Run a single command
*/
pub fn run1(&self, command: &Command) -> Command {
if self.print {
if !self.dry_run {
cprint!(&self.prompt_color, "{}", self.prompt);
}
cprintln!(
&self.command_color,
"{}",
command
.command
.replace(" && ", " \\\n&& ")
.replace(" || ", " \\\n|| ")
.replace("; ", "; \\\n"),
);
}
if self.dry_run {
return command.clone();
}
self.core(command)
}
/**
Pipe a single command
*/
pub fn pipe1(&self, command: &str) -> String {
let command = Command {
command: command.to_string(),
stdout: Pipe::string(),
..Default::default()
};
let result = self.core(&command);
if let Pipe::String(Some(stdout)) = &result.stdout {
stdout.to_string()
} else {
String::new()
}
}
/**
Core part to run/pipe a command
*/
pub fn core(&self, command: &Command) -> Command {
let (prog, args) = self.prepare(&command.command);
let mut cmd = std::process::Command::new(prog);
cmd.args(&args);
if matches!(command.stdin, Pipe::String(_)) {
cmd.stdin(std::process::Stdio::piped());
}
if matches!(command.stdout, Pipe::String(_) | Pipe::Null) {
cmd.stdout(std::process::Stdio::piped());
}
if matches!(command.stderr, Pipe::String(_) | Pipe::Null) {
cmd.stderr(std::process::Stdio::piped());
}
if self.print {
if let Pipe::String(Some(s)) = &command.stdin {
cprint!(&self.fence_color, "{}", self.fence);
cprintln!(&self.info_color, "{}", command.command);
println!("{s}");
cprintln!(&self.fence_color, "{}\n", self.fence);
cprint!(&self.fence_color, "{}", self.fence);
cprintln!(&self.info_color, "{}", self.info);
}
}
let mut child = cmd.spawn().unwrap();
if let Pipe::String(Some(s)) = &command.stdin {
let mut stdin = child.stdin.take().unwrap();
stdin.write_all(s.as_bytes()).unwrap();
}
let mut r = command.clone();
r.code = match child.wait() {
Ok(status) => status.code(),
Err(_e) => None,
};
if matches!(command.stdout, Pipe::String(_)) {
let mut stdout = String::new();
child.stdout.unwrap().read_to_string(&mut stdout).unwrap();
r.stdout = Pipe::String(Some(stdout));
}
if matches!(command.stderr, Pipe::String(_)) {
let mut stderr = String::new();
child.stderr.unwrap().read_to_string(&mut stderr).unwrap();
r.stderr = Pipe::String(Some(stderr));
}
if self.print {
if let Pipe::String(Some(_s)) = &command.stdin {
cprintln!(&self.fence_color, "{}\n", self.fence);
}
}
r
}
/**
Prepare the command
*/
fn prepare(&self, command: &str) -> (String, Vec<String>) {
if let Some(s) = &self.shell {
let mut args = shlex::split(s).unwrap();
let prog = args.remove(0);
args.push(command.to_string());
(prog, args)
} else {
// Shell disabled; run command directly
let mut args = shlex::split(command).unwrap();
let prog = args.remove(0);
(prog, args)
}
}
/**
Print the interactive prompt
*/
pub fn interactive_prompt(&self, previous: bool) {
if previous {
cprintln!(&self.fence_color, "{}\n", self.fence);
}
cprint!(&self.fence_color, "{}", self.fence);
cprintln!(&self.info_color, "{}", self.info);
cprint!(&self.prompt_color, "{}", self.prompt);
// Set the command color
let mut stdout = StandardStream::stdout(ColorChoice::Auto);
stdout.set_color(&self.command_color).unwrap();
stdout.flush().unwrap();
}
/**
Simpler interface to run command(s)
*/
pub fn run_str(&self, commands: &[&str]) -> Vec<Command> {
self.run(&commands.iter().map(|x| Command::new(x)).collect::<Vec<_>>())
}
}
//--------------------------------------------------------------------------------------------------
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Command {
pub command: String,
pub stdin: Pipe,
pub codes: Vec<i32>,
pub stdout: Pipe,
pub stderr: Pipe,
pub code: Option<i32>,
}
impl Default for Command {
fn default() -> Command {
Command {
command: Default::default(),
stdin: Pipe::Null,
codes: vec![0],
stdout: Pipe::Stdout,
stderr: Pipe::Stderr,
code: Default::default(),
}
}
}
impl Command {
pub fn new(command: &str) -> Command {
Command {
command: command.to_string(),
..Default::default()
}
}
}