feat: support override severity of unused-suppression

HerringtonDarkholme · HerringtonDarkholme · commit 2b26b0bbb8ca · 2024-10-29T05:05:40.000Z
fix ast-grep#1556
diff --git a/crates/cli/src/scan.rs b/crates/cli/src/scan.rs
@@ -105,11 +105,14 @@ struct ScanWithConfig<Printer> {
   arg: ScanArg,
   printer: Printer,
   configs: RuleCollection<SgLang>,
+  unused_suppression_rule: RuleConfig<SgLang>,
   trace: ScanTrace,
 }
 impl<P: Printer> ScanWithConfig<P> {
   fn try_new(arg: ScanArg, printer: P, project: Result<ProjectConfig>) -> Result<Self> {
     let mut rule_trace = RuleTrace::default();
+    let overwrite = RuleOverwrite::new(&arg.overwrite)?;
+    let unused_suppression_rule = unused_supression_rule_config(&overwrite);
     let configs = if let Some(path) = &arg.rule {
       let rules = read_rule_file(path, None)?;
       RuleCollection::try_new(rules).context(EC::GlobPattern)?
@@ -120,7 +123,6 @@ impl<P: Printer> ScanWithConfig<P> {
     } else {
       // 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;
       configs
@@ -130,6 +132,7 @@ impl<P: Printer> ScanWithConfig<P> {
       arg,
       printer,
       configs,
+      unused_suppression_rule,
       trace,
     })
   }
@@ -168,6 +171,7 @@ impl<P: Printer> Worker for ScanWithConfig<P> {
       print_unused_suppressions(
         path,
         scanned.unused_suppressions,
+        &self.unused_suppression_rule,
         &file_content,
         &self.printer,
       )?;
@@ -184,12 +188,7 @@ impl<P: Printer> Worker for ScanWithConfig<P> {
   }
 }
 
-fn print_unused_suppressions(
-  path: &Path,
-  matches: Vec<NodeMatch<StrDoc<SgLang>>>,
-  file_content: &String,
-  printer: &impl Printer,
-) -> Result<()> {
+fn unused_supression_rule_config(overwrite: &RuleOverwrite) -> RuleConfig<SgLang> {
   let rule: SerializableRule = serde_json::from_str(r#"{"pattern": "a"}"#).unwrap();
   let core = SerializableRuleCore {
     rule,
@@ -198,21 +197,34 @@ fn print_unused_suppressions(
     transform: None,
     utils: None,
   };
+  let severity = overwrite
+    .find("unused-suppression")
+    .severity
+    .unwrap_or(Severity::Hint);
   let config = SerializableRuleConfig::<SgLang> {
     core,
     id: "unused-suppression".to_string(),
+    severity,
     files: None,
     ignores: None,
     language: "rust".parse().unwrap(),
-    message: "Unused '@ast-grep-ignore' directive.".into(),
+    message: "Unused 'ast-grep-ignore' directive.".into(),
     metadata: None,
     note: None,
     rewriters: None,
-    severity: Severity::Hint,
     url: None,
   };
-  let rule_config = RuleConfig::try_from(config, &Default::default()).unwrap();
-  match_rule_on_file(path, matches, &rule_config, file_content, printer)
+  RuleConfig::try_from(config, &Default::default()).unwrap()
+}
+
+fn print_unused_suppressions(
+  path: &Path,
+  matches: Vec<NodeMatch<StrDoc<SgLang>>>,
+  rule_config: &RuleConfig<SgLang>,
+  file_content: &String,
+  printer: &impl Printer,
+) -> Result<()> {
+  match_rule_on_file(path, matches, rule_config, file_content, printer)
 }
 
 impl<P: Printer> PathWorker for ScanWithConfig<P> {
diff --git a/crates/cli/src/utils/rule_overwrite.rs b/crates/cli/src/utils/rule_overwrite.rs
@@ -89,7 +89,7 @@ impl RuleOverwrite {
     Ok(configs)
   }
 
-  fn find(&self, id: &str) -> OverwriteResult {
+  pub fn find(&self, id: &str) -> OverwriteResult {
     let severity = self
       .by_rule_id
       .get(id)
@@ -115,8 +115,8 @@ fn filter_rule_by_regex(
   }
 }
 
-struct OverwriteResult {
-  severity: Option<Severity>,
+pub struct OverwriteResult {
+  pub severity: Option<Severity>,
 }
 
 impl OverwriteResult {

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ impl RuleOverwrite {`
`89`	`89`	`Ok(configs)`
`90`	`90`	`}`
`91`	`91`
`92`		`- fn find(&self, id: &str) -> OverwriteResult {`
	`92`	`+ pub fn find(&self, id: &str) -> OverwriteResult {`
`93`	`93`	`let severity = self`
`94`	`94`	`.by_rule_id`
`95`	`95`	`.get(id)`
`@@ -115,8 +115,8 @@ fn filter_rule_by_regex(`
`115`	`115`	`}`
`116`	`116`	`}`
`117`	`117`
`118`		`-struct OverwriteResult {`
`119`		`- severity: Option<Severity>,`
	`118`	`+pub struct OverwriteResult {`
	`119`	`+ pub severity: Option<Severity>,`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`impl OverwriteResult {`