feat: automatic package manager install when autofixing

README.md

@@ -58,12 +58,20 @@ jobs:
 
 ## Autofix
 
-Most issues can be automatically fixed by using the `--fix` flag. Note that autofix is disabled in CI environments (when `$CI` is set):
+Most issues can be automatically fixed by using the `--fix` flag. Sherif tries to auto-detect your package manager and runs install. Note that autofix is disabled in CI environments (when `$CI` is set):
 
 ```bash
 sherif --fix
 ```
 
+## No-install mode
+
+When you don't want Sherif to install packages after running autofix, you can use the `--no-install` flag: 
+
+```bash
+sherif --fix --no-install
+```
+
 ## Rules
 
 You can ignore a specific rule by using `--ignore-rule <name>` (or `-r <name>`):

fixtures/install/apps/abc/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "abc"
+}

fixtures/install/apps/def/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "def"
+}

fixtures/install/package.json

@@ -0,0 +1,6 @@
+{
+    "name": "install",
+    "workspaces": [
+        "apps/*"
+    ]
+}

src/args.rs

@@ -8,9 +8,13 @@ pub struct Args {
     pub path: PathBuf,
 
     /// Fix the issues automatically, if possible.
-    #[arg(long)]
+    #[arg(long, short)]
     pub fix: bool,
 
+    /// Don't run the package manager install command.
+    #[arg(long)]
+    pub no_install: bool,
+
     /// Ignore the `multiple-dependency-versions` rule for the given dependency name.
     #[arg(long, short)]
     pub ignore_dependency: Vec<String>,

src/collect.rs

@@ -282,6 +282,7 @@ mod test {
         let args = Args {
             path: "unknown".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -301,6 +302,7 @@ mod test {
         let args = Args {
             path: "fixtures/empty".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -320,6 +322,7 @@ mod test {
         let args = Args {
             path: "fixtures/basic".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -345,6 +348,7 @@ mod test {
         let args = Args {
             path: "fixtures/pnpm".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -370,6 +374,7 @@ mod test {
         let args = Args {
             path: "fixtures/yarn-nohoist".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -395,6 +400,7 @@ mod test {
         let args = Args {
             path: "fixtures/no-workspace-pnpm".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -414,6 +420,7 @@ mod test {
         let args = Args {
             path: "fixtures/without-package-json".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -440,6 +447,7 @@ mod test {
         let args = Args {
             path: "fixtures/ignore-paths".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -472,6 +480,7 @@ mod test {
         let args = Args {
             path: "fixtures/root-issues".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -506,6 +515,7 @@ mod test {
     fn collect_root_issues_fixed() {
         let args = Args {
             fix: false,
+            no_install: true,
             path: "fixtures/root-issues-fixed".into(),
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
@@ -524,6 +534,7 @@ mod test {
         let args = Args {
             path: "fixtures/dependencies".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -552,6 +563,7 @@ mod test {
         let args = Args {
             path: "fixtures/dependencies-star".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),
@@ -576,6 +588,7 @@ mod test {
         let args = Args {
             path: "fixtures/pnpm-glob".into(),
             fix: false,
+            no_install: true,
             ignore_rule: Vec::new(),
             ignore_package: Vec::new(),
             ignore_dependency: Vec::new(),

src/install.rs

@@ -0,0 +1,123 @@
+use std::process::Stdio;
+use std::{fs, process::Command};
+
+use colored::Colorize;
+use inquire::Select;
+
+
+pub fn run () {
+    let mut package_manager = detect_package_manager();
+
+    if package_manager.is_empty() {
+        println!("Could not auto-detect package manager.");
+       package_manager = manual_select_package_manager();
+    }
+
+    println!("Running install using: {}...", package_manager);
+
+    let mut command = Command::new(package_manager)
+        .arg("install")
+        .stdout(Stdio::inherit())
+        .stderr(Stdio::inherit())
+        .spawn()
+        .unwrap();
+
+    let status = command.wait().unwrap();
+
+    if !status.success() {
+        println!("{} Failed to run `install`.", "✗".red());
+        std::process::exit(1);
+    }
+
+    println!("{} Install completed.", "✓".green());
+}
+
+fn detect_package_manager () -> String {
+    if fs::metadata("package-lock.json").is_ok() {
+        return "npm".to_string();
+    } 
+
+    if fs::metadata("yarn.lock").is_ok() {
+        return "yarn".to_string();
+    } 
+
+    if fs::metadata("pnpm-lock.yaml").is_ok() {
+        return "pnpm".to_string();
+    } 
+
+    return "".to_string();
+}
+
+fn manual_select_package_manager () -> String {
+    let package_manager = Select::new("Select a package manager", vec!["npm", "yarn", "pnpm"])
+        .prompt();
+
+    match package_manager {
+        Ok("npm") => {
+            return "npm".to_string();
+        }
+        Ok("yarn") => {
+            return "yarn".to_string();
+        }
+        Ok("pnpm") => {
+            return "pnpm".to_string();
+        }
+        _ => {
+            println!("Invalid package manager selected. Exiting...");
+            std::process::exit(1);
+        }
+    }
+}
+
+#[cfg(test)]
+
+mod test {
+    use std::fs;
+    use serde_json::Value;
+    use crate::{args::Args, collect::collect_packages};
+
+    #[test]
+    fn test_detect_package_manager() {
+        use super::*;
+        use std::fs;
+
+        fs::File::create("package-lock.json").unwrap();
+        assert_eq!(detect_package_manager(), "npm");
+
+        fs::remove_file("package-lock.json").unwrap();
+        fs::File::create("yarn.lock").unwrap();
+        assert_eq!(detect_package_manager(), "yarn");
+
+        fs::remove_file("yarn.lock").unwrap();
+        fs::File::create("pnpm-lock.yaml").unwrap();
+        assert_eq!(detect_package_manager(), "pnpm");
+
+        fs::remove_file("pnpm-lock.yaml").unwrap();
+        assert_eq!(detect_package_manager(), "");
+    }
+
+    #[test]
+    fn test_install_run() {
+          let args = Args {
+            path: "fixtures/install".into(),
+            fix: false,
+            no_install: false,
+            ignore_rule: Vec::new(),
+            ignore_package: Vec::new(),
+            ignore_dependency: Vec::new(),
+        };
+
+        let _ = collect_packages(&args);
+
+        std::env::set_current_dir("fixtures/install").unwrap();
+        super::run();
+
+        // Test if the previously empty package-lock.json now contains the "install" name to indicate that the install command was run
+        let file = fs::File::open("package-lock.json");
+        let json: Result<Value, serde_json::Error> = serde_json::from_reader(file.unwrap());
+        assert_eq!(json.unwrap()["name"], "install");
+
+        std::env::set_current_dir("../../").unwrap();
+    }
+
+}

src/main.rs

@@ -3,11 +3,13 @@ use crate::rules::IssueLevel;
 use crate::{args::Args, printer::print_error};
 use clap::Parser;
 use collect::{collect_issues, collect_packages};
+use colored::Colorize;
 use printer::{print_footer, print_issues};
 use std::time::Instant;
 
 mod args;
 mod collect;
+mod install;
 mod json;
 mod packages;
 mod plural;
@@ -69,4 +71,16 @@ fn main() {
     if errors > 0 {
         std::process::exit(1);
     }
+
+    if args.fix {
+        if args.no_install {
+            println!(
+                "{}",
+                " Don't forget to run `install` to apply the changes.".bright_black()
+            );
+            return;
+        }
+
+        install::run();
+    }
 }

src/printer.rs

@@ -71,7 +71,7 @@ pub fn print_footer(
     );
     println!(
         "{}",
-        " Note: use `-i` to ignore dependencies, `-r` to ignore rules, `-p` to ignore packages, and `--fix` to autofix fixable issues."
+        " Note: use `-i` to ignore dependencies, `-r` to ignore rules, `-p` to ignore packages, and `-f` to autofix fixable issues."
             .bright_black()
     );
 }