feat: support --config in sg new

HerringtonDarkholme · HerringtonDarkholme · commit cfe472f63c70 · 2024-10-26T16:01:49.000-04:00
BREAKING CHANGE: --base-dir is removed and superseded by --config
diff --git a/crates/cli/src/config.rs b/crates/cli/src/config.rs
@@ -66,14 +66,8 @@ impl ProjectConfig {
   pub fn by_config_path(config_path: Option<PathBuf>) -> Result<Option<Self>> {
     Self::discover_project(config_path, None)
   }
-  pub fn by_project_dir(project_dir: &Path) -> Result<Option<Self>> {
-    Self::discover_project(None, Some(project_dir))
-  }
   // return None if config file does not exist
-  pub fn discover_project(
-    config_path: Option<PathBuf>,
-    base: Option<&Path>,
-  ) -> Result<Option<Self>> {
+  fn discover_project(config_path: Option<PathBuf>, base: Option<&Path>) -> Result<Option<Self>> {
     let config_path =
       find_config_path_with_default(config_path, base).context(EC::ReadConfiguration)?;
     // NOTE: if config file does not exist, return None
diff --git a/crates/cli/src/new.rs b/crates/cli/src/new.rs
@@ -8,7 +8,7 @@ use inquire::validator::ValueRequiredValidator;
 
 use std::fmt::Display;
 use std::fs::{self, File};
-use std::path::PathBuf;
+use std::path::{Path, PathBuf};
 
 #[derive(Parser)]
 pub struct NewArg {
@@ -29,25 +29,33 @@ pub struct NewArg {
   /// Please see the command description for the what arguments are required.
   #[arg(short, long, global = true)]
   yes: bool,
-  /// Create new project/items in the folder specified by this argument.
-  #[arg(short, long, global = true, default_value = ".")]
-  base_dir: PathBuf,
+
+  /// Path to ast-grep root config, default is sgconfig.yml.
+  #[clap(short, long, value_name = "CONFIG_FILE")]
+  config: Option<PathBuf>,
+}
+
+fn create_dir(project_dir: &Path, dir: &str) -> Result<PathBuf> {
+  let path = project_dir.join(dir);
+  fs::create_dir_all(&path)?;
+  // create a .gitkeep file to keep the folder in git
+  // https://github.com/ast-grep/ast-grep/issues/1273
+  let gitkeep = path.join(".gitkeep");
+  File::create(gitkeep)?;
+  Ok(path)
 }
 
 impl NewArg {
-  fn ask_dir_and_create(&self, prompt: &str, default: &str) -> Result<PathBuf> {
+  fn find_project_config(&self) -> Result<Option<ProjectConfig>> {
+    ProjectConfig::by_config_path(self.config.clone())
+  }
+  fn ask_dir(&self, prompt: &str, default: &str) -> Result<String> {
     let dir = if self.yes {
       default.to_owned()
     } else {
       inquire::Text::new(prompt).with_default(default).prompt()?
     };
-    let path = self.base_dir.join(dir);
-    fs::create_dir_all(&path)?;
-    // create a .gitkeep file to keep the folder in git
-    // https://github.com/ast-grep/ast-grep/issues/1273
-    let gitkeep = path.join(".gitkeep");
-    File::create(gitkeep)?;
-    Ok(path)
+    Ok(dir)
   }
 
   fn confirm(&self, prompt: &str) -> Result<bool> {
@@ -144,8 +152,8 @@ impl Display for Entity {
 }
 
 pub fn run_create_new(mut arg: NewArg) -> Result<()> {
-  let config_path = ProjectConfig::by_project_dir(&arg.base_dir)?;
-  register_custom_language(config_path)?;
+  let project_config = arg.find_project_config()?;
+  register_custom_language(project_config)?;
   if let Some(entity) = arg.entity.take() {
     run_create_entity(entity, arg)
   } else {
@@ -155,12 +163,12 @@ pub fn run_create_new(mut arg: NewArg) -> Result<()> {
 
 fn run_create_entity(entity: Entity, arg: NewArg) -> Result<()> {
   // check if we are under a project dir
-  if let Some(found) = ProjectConfig::by_project_dir(&arg.base_dir)? {
+  if let Some(found) = arg.find_project_config()? {
     return do_create_entity(entity, found, arg);
   }
   // check if we creating a project
   if entity == Entity::Project {
-    create_new_project(arg)
+    create_new_project(arg, std::env::current_dir()?.as_path())
   } else {
     // if not, return error
     Err(anyhow::anyhow!(EC::ProjectNotExist))
@@ -179,29 +187,33 @@ fn do_create_entity(entity: Entity, found: ProjectConfig, arg: NewArg) -> Result
 
 fn ask_entity_type(arg: NewArg) -> Result<()> {
   // 1. check if we are under a sgconfig.yml
-  if let Some(found) = ProjectConfig::by_project_dir(&arg.base_dir)? {
+  if let Some(found) = arg.find_project_config()? {
     // 2. ask users what to create if yes
     let entity = arg.ask_entity_type()?;
     do_create_entity(entity, found, arg)
   } else {
     // 3. ask users to provide project info if no sgconfig found
     print!("No sgconfig.yml found. ");
-    create_new_project(arg)
+    let current_dir = std::env::current_dir()?;
+    create_new_project(arg, &current_dir)
   }
 }
 
-fn create_new_project(arg: NewArg) -> Result<()> {
+fn create_new_project(arg: NewArg, project_dir: &Path) -> Result<()> {
   println!("Creating a new ast-grep project...");
-  let rule_dirs = arg.ask_dir_and_create("Where do you want to have your rules?", "rules")?;
+  let ask_dir_and_create = |prompt: &str, default: &str| -> Result<PathBuf> {
+    let dir = arg.ask_dir(prompt, default)?;
+    create_dir(project_dir, &dir)
+  };
+  let rule_dirs = ask_dir_and_create("Where do you want to have your rules?", "rules")?;
   let test_dirs = if arg.confirm("Do you want to create rule tests?")? {
-    let test_dirs =
-      arg.ask_dir_and_create("Where do you want to have your tests?", "rule-tests")?;
+    let test_dirs = ask_dir_and_create("Where do you want to have your tests?", "rule-tests")?;
     Some(TestConfig::from(test_dirs))
   } else {
     None
   };
   let utils = if arg.confirm("Do you want to create folder for utility rules?")? {
-    let util_dirs = arg.ask_dir_and_create("Where do you want to have your utilities?", "utils")?;
+    let util_dirs = ask_dir_and_create("Where do you want to have your utilities?", "utils")?;
     Some(util_dirs)
   } else {
     None
@@ -214,7 +226,7 @@ fn create_new_project(arg: NewArg) -> Result<()> {
     language_globs: None,        // advanced feature, skip now
     language_injections: vec![], // advanced feature
   };
-  let config_path = arg.base_dir.join("sgconfig.yml");
+  let config_path = project_dir.join("sgconfig.yml");
   let f = File::create(config_path)?;
   serde_yaml::to_writer(f, &root_config)?;
   println!("Your new ast-grep project has been created!");
@@ -358,9 +370,9 @@ mod test {
       name: None,
       lang: None,
       yes: true,
-      base_dir: tempdir.to_path_buf(),
+      config: None,
     };
-    run_create_new(arg)?;
+    create_new_project(arg, tempdir)?;
     assert!(tempdir.join("sgconfig.yml").exists());
     Ok(())
   }
@@ -371,9 +383,9 @@ mod test {
       name: Some("test-rule".into()),
       lang: Some(SupportLang::Rust.into()),
       yes: true,
-      base_dir: temp.to_path_buf(),
+      config: Some(temp.join("sgconfig.yml")),
     };
-    run_create_new(arg).unwrap();
+    run_create_new(arg)?;
     assert!(temp.join("rules/test-rule.yml").exists());
     Ok(())
   }
@@ -384,9 +396,9 @@ mod test {
       name: Some("test-utils".into()),
       lang: Some(SupportLang::Rust.into()),
       yes: true,
-      base_dir: temp.to_path_buf(),
+      config: Some(temp.join("sgconfig.yml")),
     };
-    run_create_new(arg).unwrap();
+    run_create_new(arg)?;
     assert!(temp.join("utils/test-utils.yml").exists());
     Ok(())
   }
