refactor: unify error

HerringtonDarkholme · HerringtonDarkholme · commit 920d45bed95c · 2024-10-28T04:41:57.000Z
diff --git a/crates/cli/src/config.rs b/crates/cli/src/config.rs
@@ -90,9 +90,9 @@ impl ProjectConfig {
     read_directory_yaml(self, global_rules, rule_overwrite)
   }
   // do not report error if no sgconfig.yml is found
-  pub fn setup(config_path: Option<PathBuf>) -> Result<Option<Self>> {
+  pub fn setup(config_path: Option<PathBuf>) -> Result<Result<Self>> {
     let Some((project_dir, mut sg_config)) = Self::discover_project(config_path)? else {
-      return Ok(None);
+      return Ok(Err(anyhow::anyhow!(EC::ProjectNotExist)));
     };
     let config = ProjectConfig {
       project_dir,
@@ -102,7 +102,7 @@ impl ProjectConfig {
     };
     // sg_config will not use rule dirs and test configs anymore
     register_custom_language(&config.project_dir, sg_config)?;
-    Ok(Some(config))
+    Ok(Ok(config))
   }
 }
 
diff --git a/crates/cli/src/lsp.rs b/crates/cli/src/lsp.rs
@@ -15,9 +15,7 @@ pub struct LspArg {
 async fn run_language_server_impl(arg: LspArg) -> Result<()> {
   // env_logger::init();
   // TODO: move this error to client
-  let Some(project_config) = ProjectConfig::setup(arg.config.clone())? else {
-    return Err(anyhow::anyhow!(EC::ProjectNotExist));
-  };
+  let project_config = ProjectConfig::setup(arg.config.clone())??;
   let stdin = tokio::io::stdin();
   let stdout = tokio::io::stdout();
   let config_result = project_config.find_rules(Default::default());
diff --git a/crates/cli/src/new.rs b/crates/cli/src/new.rs
@@ -157,9 +157,9 @@ pub fn run_create_new(mut arg: NewArg) -> Result<()> {
   }
 }
 
-fn run_create_entity(entity: Entity, arg: NewArg, project: Option<ProjectConfig>) -> Result<()> {
+fn run_create_entity(entity: Entity, arg: NewArg, project: Result<ProjectConfig>) -> Result<()> {
   // check if we are under a project dir
-  if let Some(found) = project {
+  if let Ok(found) = project {
     return do_create_entity(entity, found, arg);
   }
   // check if we creating a project
@@ -181,9 +181,9 @@ fn do_create_entity(entity: Entity, found: ProjectConfig, arg: NewArg) -> Result
   }
 }
 
-fn ask_entity_type(arg: NewArg, project: Option<ProjectConfig>) -> Result<()> {
+fn ask_entity_type(arg: NewArg, project: Result<ProjectConfig>) -> Result<()> {
   // 1. check if we are under a sgconfig.yml
-  if let Some(found) = project {
+  if let Ok(found) = project {
     // 2. ask users what to create if yes
     let entity = arg.ask_entity_type()?;
     do_create_entity(entity, found, arg)
diff --git a/crates/cli/src/run.rs b/crates/cli/src/run.rs
@@ -22,7 +22,7 @@ pub fn register_custom_language_if_is_run(args: &[String]) -> Result<()> {
     return Ok(());
   };
   if arg.starts_with('-') || arg == "run" {
-    ProjectConfig::setup(None)?;
+    _ = ProjectConfig::setup(None)?;
   }
   Ok(())
 }
diff --git a/crates/cli/src/scan.rs b/crates/cli/src/scan.rs
@@ -109,7 +109,7 @@ struct ScanWithConfig<Printer> {
   trace: ScanTrace,
 }
 impl<P: Printer> ScanWithConfig<P> {
-  fn try_new(arg: ScanArg, printer: P, project: Option<ProjectConfig>) -> Result<Self> {
+  fn try_new(arg: ScanArg, printer: P, project: Result<ProjectConfig>) -> Result<Self> {
     let mut rule_trace = RuleTrace::default();
     let configs = if let Some(path) = &arg.rule {
       let rules = read_rule_file(path, None)?;
@@ -119,7 +119,8 @@ impl<P: Printer> ScanWithConfig<P> {
         .with_context(|| EC::ParseRule("INLINE_RULES".into()))?;
       RuleCollection::try_new(rules).context(EC::GlobPattern)?
     } else {
-      let project_config = project.ok_or_else(|| anyhow::anyhow!(EC::ProjectNotExist))?;
+      // NOTE: only query project here since -r does not need project
+      let project_config = project?;
       let overwrite = RuleOverwrite::new(&arg.overwrite)?;
       let (configs, r_stats) = project_config.find_rules(overwrite)?;
       rule_trace = r_stats;
diff --git a/crates/cli/src/verify.rs b/crates/cli/src/verify.rs
@@ -187,8 +187,7 @@ pub struct TestArg {
 }
 
 pub fn run_test_rule(arg: TestArg) -> Result<()> {
-  let project = ProjectConfig::setup(arg.config.clone())?
-    .ok_or_else(|| anyhow!(ErrorContext::ProjectNotExist))?;
+  let project = ProjectConfig::setup(arg.config.clone())??;
   if arg.interactive {
     let reporter = InteractiveReporter {
       output: std::io::stdout(),

Original file line number	Diff line number	Diff line change
`@@ -90,9 +90,9 @@ impl ProjectConfig {`
`90`	`90`	`read_directory_yaml(self, global_rules, rule_overwrite)`
`91`	`91`	`}`
`92`	`92`	`// do not report error if no sgconfig.yml is found`
`93`		`- pub fn setup(config_path: Option<PathBuf>) -> Result<Option<Self>> {`
	`93`	`+ pub fn setup(config_path: Option<PathBuf>) -> Result<Result<Self>> {`
`94`	`94`	`let Some((project_dir, mut sg_config)) = Self::discover_project(config_path)? else {`
`95`		`- return Ok(None);`
	`95`	`+ return Ok(Err(anyhow::anyhow!(EC::ProjectNotExist)));`
`96`	`96`	`};`
`97`	`97`	`let config = ProjectConfig {`
`98`	`98`	`project_dir,`
`@@ -102,7 +102,7 @@ impl ProjectConfig {`
`102`	`102`	`};`
`103`	`103`	`// sg_config will not use rule dirs and test configs anymore`
`104`	`104`	`register_custom_language(&config.project_dir, sg_config)?;`
`105`		`- Ok(Some(config))`
	`105`	`+ Ok(Ok(config))`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`
Original file line number	Diff line number	Diff line change
`@@ -157,9 +157,9 @@ pub fn run_create_new(mut arg: NewArg) -> Result<()> {`
`157`	`157`	`}`
`158`	`158`	`}`
`159`	`159`
`160`		`-fn run_create_entity(entity: Entity, arg: NewArg, project: Option<ProjectConfig>) -> Result<()> {`
	`160`	`+fn run_create_entity(entity: Entity, arg: NewArg, project: Result<ProjectConfig>) -> Result<()> {`
`161`	`161`	`// check if we are under a project dir`
`162`		`- if let Some(found) = project {`
	`162`	`+ if let Ok(found) = project {`
`163`	`163`	`return do_create_entity(entity, found, arg);`
`164`	`164`	`}`
`165`	`165`	`// check if we creating a project`
`@@ -181,9 +181,9 @@ fn do_create_entity(entity: Entity, found: ProjectConfig, arg: NewArg) -> Result`
`181`	`181`	`}`
`182`	`182`	`}`
`183`	`183`
`184`		`-fn ask_entity_type(arg: NewArg, project: Option<ProjectConfig>) -> Result<()> {`
	`184`	`+fn ask_entity_type(arg: NewArg, project: Result<ProjectConfig>) -> Result<()> {`
`185`	`185`	`// 1. check if we are under a sgconfig.yml`
`186`		`- if let Some(found) = project {`
	`186`	`+ if let Ok(found) = project {`
`187`	`187`	`// 2. ask users what to create if yes`
`188`	`188`	`let entity = arg.ask_entity_type()?;`
`189`	`189`	`do_create_entity(entity, found, arg)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ pub fn register_custom_language_if_is_run(args: &[String]) -> Result<()> {`
`22`	`22`	`return Ok(());`
`23`	`23`	`};`
`24`	`24`	`if arg.starts_with('-') \|\| arg == "run" {`
`25`		`- ProjectConfig::setup(None)?;`
	`25`	`+ _ = ProjectConfig::setup(None)?;`
`26`	`26`	`}`
`27`	`27`	`Ok(())`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -187,8 +187,7 @@ pub struct TestArg {`
`187`	`187`	`}`
`188`	`188`
`189`	`189`	`pub fn run_test_rule(arg: TestArg) -> Result<()> {`
`190`		`- let project = ProjectConfig::setup(arg.config.clone())?`
`191`		`- .ok_or_else(\|\| anyhow!(ErrorContext::ProjectNotExist))?;`
	`190`	`+ let project = ProjectConfig::setup(arg.config.clone())??;`
`192`	`191`	`if arg.interactive {`
`193`	`192`	`let reporter = InteractiveReporter {`
`194`	`193`	`output: std::io::stdout(),`