xshell-macros

A major release with significant changes to the API:

• Interior mutability and references are removed. Both Cmd and Shell are now values.
• pushd-style API are removed in favor of Shell-returning functional builders like with_current_dir.
• Split copy_file into copy_file and copy_file_to_dir, removing auto-magical directory detection.
• Remove fine-grained control of stdin streams from Cmd. Instead:
  • There's a menu of run, run_echo, run_interactive, read that generally try to do the right thing.
  • run no longer echoes the command by default, run_echo does that.
  • The error messages now carry last 128KiB of stdout/stderr and print them on error.
  • There's to_command method for converting to std::process::Command which does allow for fine grained control.
• Support for timeouts.
• MSRV is raised to 1.73.0.

• MSRV is raised to 1.63.0
• Avoid using non-existant cfg in macros

• Implement Clone for Shell.

need Rust 1.66 for blocking cargo publish

• Improve error message when a working directory for cmd! does not exist.

61: fix run ignoring stdin r=matklad a=matklad

bors r+
🤖

Co-authored-by: Aleksey Kladov [email protected]

• Fix bug where Cmd::run would ignore specified stdin.

56: Add path_exists r=lnicola a=azdavis

Just returns whether the path exists.

Co-authored-by: Ariel Davis [email protected]

• Add Shell::path_exists.

55: remove_path is idempotent r=lnicola a=matklad

Co-authored-by: Aleksey Kladov [email protected]

• Shell::remove_path returns Ok if the path does not exist (ie the function is now idempotent).

51: Fix pre-release publishing r=matklad a=matklad

bors r+

Co-authored-by: Aleksey Kladov [email protected]

A major release with significant changes to the API:

• All global state is removed in favor of explicitly passing a Shell instance.
• Some methods are renamed to better match Rust naming conventions.
• New APIs for controlling working directory and environment.
• MSRV is raised to 1.59.0.
• Improved reliability across the board: the crate aims to become a dependable 1.0 tool in the future (no ETA).
• This is expected to be the last large API reshuffle.

48: v0.2.0-pre.1 r=matklad a=matklad

bors r+

Co-authored-by: Aleksey Kladov [email protected]

• Allow panics to transparently pass through xshell calls. This removes some internal lock poisoned errors.

• Add xshell::hard_link.

• Correctly handle multiple internal read guards.

• Correctly handle commands name starting with quote.

• Add ignore_stdout, ignore_stderr functions.

• Add env, env_revome, env_clear functions.

• write_file now creates the intervening directory path if it doesn't exit.

• echo_cmd output goes to stderr, not stdout.

• mktemp_d creates an (insecure, world readable) temporary directory.
• Fix cp docs.

• Add option to not echo command at all.
• Add option to censor command contents when echoing.
• Add docs.

• cp(foo, bar) copies foo into bar, if bar is an existing directory.
• Tweak reading API.

• .read() chomps \r\n on Windows.
• Prevent cwd/env races when using .read() or .run().
• Better spans in error messages.

• Improve proc-macro error messages.

• No changelog until this point :(