Switch from not_bash to xshell

Author: matklad

Cargo.lock

@@ -18,5 +18,5 @@ quote = "1.0.2"
 ungrammar = "1.1.3"
 walkdir = "2.3.1"
 write-json =  "0.1.0"
-fs-err = "2.3"
+xshell = "0.1"
 # Avoid adding more dependencies to this crate

xtask/Cargo.toml

@@ -15,12 +15,9 @@ use std::{
     fmt, mem,
     path::{Path, PathBuf},
 };
+use xshell::{cmd, pushenv, read_file, write_file};
 
-use crate::{
-    ensure_rustfmt,
-    not_bash::{fs2, pushenv, run},
-    project_root, Result,
-};
+use crate::{ensure_rustfmt, project_root, Result};
 
 pub use self::{
     gen_assists_docs::{generate_assists_docs, generate_assists_tests},
@@ -57,7 +54,7 @@ impl CodegenCmd {
 /// A helper to update file on disk if it has changed.
 /// With verify = false,
 fn update(path: &Path, contents: &str, mode: Mode) -> Result<()> {
-    match fs2::read_to_string(path) {
+    match read_file(path) {
         Ok(old_contents) if normalize(&old_contents) == normalize(contents) => {
             return Ok(());
         }
@@ -67,7 +64,7 @@ fn update(path: &Path, contents: &str, mode: Mode) -> Result<()> {
         anyhow::bail!("`{}` is not up-to-date", path.display());
     }
     eprintln!("updating {}", path.display());
-    fs2::write(path, contents)?;
+    write_file(path, contents)?;
     return Ok(());
 
     fn normalize(s: &str) -> String {
@@ -80,10 +77,10 @@ const PREAMBLE: &str = "Generated file, do not edit by hand, see `xtask/src/code
 fn reformat(text: &str) -> Result<String> {
     let _e = pushenv("RUSTUP_TOOLCHAIN", "stable");
     ensure_rustfmt()?;
-    let stdout = run!(
-        "rustfmt --config-path {} --config fn_single_line=true", project_root().join("rustfmt.toml").display();
-        <text.as_bytes()
-    )?;
+    let rustfmt_toml = project_root().join("rustfmt.toml");
+    let stdout = cmd!("rustfmt --config-path {rustfmt_toml} --config fn_single_line=true")
+        .stdin(text)
+        .read()?;
     Ok(format!("//! {}\n\n{}\n", PREAMBLE, stdout))
 }
 

xtask/src/codegen.rs

@@ -3,15 +3,13 @@ use std::path::{Path, PathBuf};
 
 use quote::quote;
 use walkdir::WalkDir;
+use xshell::{cmd, read_file};
 
-use crate::{
-    codegen::{project_root, reformat, update, Mode, Result},
-    not_bash::{fs2, run},
-};
+use crate::codegen::{project_root, reformat, update, Mode, Result};
 
 pub fn generate_features(mode: Mode) -> Result<()> {
     if !Path::new("./target/rust").exists() {
-        run!("git clone https://github.com/rust-lang/rust ./target/rust")?;
+        cmd!("git clone https://github.com/rust-lang/rust ./target/rust").run()?;
     }
 
     let contents = generate_descriptor("./target/rust/src/doc/unstable-book/src".into())?;
@@ -34,7 +32,7 @@ fn generate_descriptor(src_dir: PathBuf) -> Result<String> {
         .map(|entry| {
             let path = entry.path();
             let feature_ident = path.file_stem().unwrap().to_str().unwrap().replace("-", "_");
-            let doc = fs2::read_to_string(path).unwrap();
+            let doc = read_file(path).unwrap();
 
             quote! { LintCompletion { label: #feature_ident, description: #doc } }
         });

xtask/src/codegen/gen_features.rs

@@ -1,4 +1,3 @@
-use flate2::{write::GzEncoder, Compression};
 use std::{
     env,
     fs::File,
@@ -7,11 +6,10 @@ use std::{
 };
 
 use anyhow::Result;
+use flate2::{write::GzEncoder, Compression};
+use xshell::{cmd, cp, mkdir_p, pushd, read_file, rm_rf, write_file};
 
-use crate::{
-    not_bash::{date_iso, fs2, pushd, rm_rf, run},
-    project_root,
-};
+use crate::{date_iso, project_root};
 
 pub struct DistCmd {
     pub nightly: bool,
@@ -22,7 +20,7 @@ impl DistCmd {
     pub fn run(self) -> Result<()> {
         let dist = project_root().join("dist");
         rm_rf(&dist)?;
-        fs2::create_dir_all(&dist)?;
+        mkdir_p(&dist)?;
 
         if let Some(version) = self.client_version {
             let release_tag = if self.nightly { "nightly".to_string() } else { date_iso()? };
@@ -34,7 +32,7 @@ impl DistCmd {
 }
 
 fn dist_client(version: &str, release_tag: &str) -> Result<()> {
-    let _d = pushd("./editors/code");
+    let _d = pushd("./editors/code")?;
     let nightly = release_tag == "nightly";
 
     let mut patch = Patch::new("./package.json")?;
@@ -54,20 +52,16 @@ fn dist_client(version: &str, release_tag: &str) -> Result<()> {
     }
     patch.commit()?;
 
-    run!("npm ci")?;
-    run!("npx vsce package -o ../../dist/rust-analyzer.vsix")?;
+    cmd!("npm ci").run()?;
+    cmd!("npx vsce package -o ../../dist/rust-analyzer.vsix").run()?;
     Ok(())
 }
 
 fn dist_server() -> Result<()> {
     if cfg!(target_os = "linux") {
         env::set_var("CC", "clang");
-        run!(
-            "cargo build --manifest-path ./crates/rust-analyzer/Cargo.toml --bin rust-analyzer --release"
-        )?;
-    } else {
-        run!("cargo build --manifest-path ./crates/rust-analyzer/Cargo.toml --bin rust-analyzer --release")?;
     }
+    cmd!("cargo build --manifest-path ./crates/rust-analyzer/Cargo.toml --bin rust-analyzer --release").run()?;
 
     let (src, dst) = if cfg!(target_os = "linux") {
         ("./target/release/rust-analyzer", "./dist/rust-analyzer-linux")
@@ -82,7 +76,7 @@ fn dist_server() -> Result<()> {
     let src = Path::new(src);
     let dst = Path::new(dst);
 
-    fs2::copy(&src, &dst)?;
+    cp(&src, &dst)?;
     gzip(&src, &dst.with_extension("gz"))?;
 
     Ok(())
@@ -105,7 +99,7 @@ struct Patch {
 impl Patch {
     fn new(path: impl Into<PathBuf>) -> Result<Patch> {
         let path = path.into();
-        let contents = fs2::read_to_string(&path)?;
+        let contents = read_file(&path)?;
         Ok(Patch { path, original_contents: contents.clone(), contents })
     }
 
@@ -115,13 +109,14 @@ impl Patch {
         self
     }
 
-    fn commit(&self) -> io::Result<()> {
-        fs2::write(&self.path, &self.contents)
+    fn commit(&self) -> Result<()> {
+        write_file(&self.path, &self.contents)?;
+        Ok(())
     }
 }
 
 impl Drop for Patch {
     fn drop(&mut self) {
-        fs2::write(&self.path, &self.original_contents).unwrap();
+        write_file(&self.path, &self.original_contents).unwrap();
     }
 }

xtask/src/dist.rs

@@ -3,8 +3,7 @@
 use std::{env, path::PathBuf, str};
 
 use anyhow::{bail, format_err, Context, Result};
-
-use crate::not_bash::{pushd, run};
+use xshell::{cmd, pushd};
 
 // Latest stable, feel free to send a PR if this lags behind.
 const REQUIRED_RUST_VERSION: u32 = 47;
@@ -76,7 +75,7 @@ fn fix_path_for_mac() -> Result<()> {
 }
 
 fn install_client(ClientOpt::VsCode: ClientOpt) -> Result<()> {
-    let _dir = pushd("./editors/code");
+    let _dir = pushd("./editors/code")?;
 
     let find_code = |f: fn(&str) -> bool| -> Result<&'static str> {
         ["code", "code-insiders", "codium", "code-oss"]
@@ -89,24 +88,25 @@ fn install_client(ClientOpt::VsCode: ClientOpt) -> Result<()> {
     };
 
     let installed_extensions = if cfg!(unix) {
-        run!("npm --version").context("`npm` is required to build the VS Code plugin")?;
-        run!("npm install")?;
+        cmd!("npm --version").run().context("`npm` is required to build the VS Code plugin")?;
+        cmd!("npm install").run()?;
 
-        run!("npm run package --scripts-prepend-node-path")?;
+        cmd!("npm run package --scripts-prepend-node-path").run()?;
 
-        let code = find_code(|bin| run!("{} --version", bin).is_ok())?;
-        run!("{} --install-extension rust-analyzer.vsix --force", code)?;
-        run!("{} --list-extensions", code; echo = false)?
+        let code = find_code(|bin| cmd!("{bin} --version").read().is_ok())?;
+        cmd!("{code} --install-extension rust-analyzer.vsix --force").run()?;
+        cmd!("{code} --list-extensions").read()?
     } else {
-        run!("cmd.exe /c npm --version")
+        cmd!("cmd.exe /c npm --version")
+            .run()
             .context("`npm` is required to build the VS Code plugin")?;
-        run!("cmd.exe /c npm install")?;
+        cmd!("cmd.exe /c npm install").run()?;
 
-        run!("cmd.exe /c npm run package")?;
+        cmd!("cmd.exe /c npm run package").run()?;
 
-        let code = find_code(|bin| run!("cmd.exe /c {}.cmd --version", bin).is_ok())?;
-        run!(r"cmd.exe /c {}.cmd --install-extension rust-analyzer.vsix --force", code)?;
-        run!("cmd.exe /c {}.cmd --list-extensions", code; echo = false)?
+        let code = find_code(|bin| cmd!("cmd.exe /c {bin}.cmd --version").read().is_ok())?;
+        cmd!("cmd.exe /c {code}.cmd --install-extension rust-analyzer.vsix --force").run()?;
+        cmd!("cmd.exe /c {code}.cmd --list-extensions").read()?
     };
 
     if !installed_extensions.contains("rust-analyzer") {
@@ -122,7 +122,7 @@ fn install_client(ClientOpt::VsCode: ClientOpt) -> Result<()> {
 
 fn install_server(opts: ServerOpt) -> Result<()> {
     let mut old_rust = false;
-    if let Ok(stdout) = run!("cargo --version") {
+    if let Ok(stdout) = cmd!("cargo --version").read() {
         if !check_version(&stdout, REQUIRED_RUST_VERSION) {
             old_rust = true;
         }
@@ -134,12 +134,13 @@ fn install_server(opts: ServerOpt) -> Result<()> {
             REQUIRED_RUST_VERSION,
         )
     }
-
-    let malloc_feature = match opts.malloc {
-        Malloc::System => "",
-        Malloc::Mimalloc => "--features mimalloc",
+    let features = match opts.malloc {
+        Malloc::System => &[][..],
+        Malloc::Mimalloc => &["--features", "mimalloc"],
     };
-    let res = run!("cargo install --path crates/rust-analyzer --locked --force {}", malloc_feature);
+
+    let cmd = cmd!("cargo install --path crates/rust-analyzer --locked --force {features...}");
+    let res = cmd.run();
 
     if res.is_err() && old_rust {
         eprintln!(
@@ -148,7 +149,8 @@ fn install_server(opts: ServerOpt) -> Result<()> {
         );
     }
 
-    res.map(drop)
+    res?;
+    Ok(())
 }
 
 fn check_version(version_output: &str, min_minor_version: u32) -> bool {