Add helper functions and docstrings (#18)

Author: 0xGeorgii

compact-scanner/src/main.rs

@@ -1,3 +1,4 @@
+#![warn(clippy::pedantic)]
 use clap::Parser;
 use compact_security_detectors::all_detectors;
 use compact_security_detectors_sdk::{
@@ -7,7 +8,7 @@ use compact_security_detectors_sdk::{
 use libloading::{Library, Symbol};
 use parser::Cli;
 use serde_json::{json, Map};
-use std::collections::HashMap;
+use std::{collections::HashMap, path::PathBuf};
 
 mod parser;
 
@@ -46,17 +47,18 @@ fn main() {
                     corpus.insert(path.to_string_lossy().to_string(), file_content);
                 }
             }
+            let mut files_scanned = Vec::new();
+            let mut detector_responses = Map::new();
             if !corpus.is_empty() {
-                let result = execute_detectors(&corpus, detectors, load_lib);
+                let result = execute_detectors(&corpus, detectors.as_ref(), load_lib);
 
-                let files_scanned: Vec<String> = corpus
+                files_scanned = corpus
                     .keys()
-                    .map(|k| relative_file_path(k, &project_root))
+                    .map(|k| relative_file_path(k, project_root.as_ref()))
                     .collect();
 
-                let mut detector_responses = Map::new();
                 for (detector_name, errors) in result {
-                    let instances = detector_result_to_json(errors, &project_root);
+                    let instances = detector_result_to_json(errors, project_root.as_ref());
 
                     let detector_response = json!({
                         "findings": [
@@ -69,15 +71,14 @@ fn main() {
                     });
                     detector_responses.insert(detector_name, detector_response);
                 }
-
-                let res = json!({
-                    "errors": [],
-                    "scanned": files_scanned,
-                    "detector_responses": detector_responses,
-                });
-
-                println!("{}", serde_json::to_string_pretty(&res).unwrap());
             }
+            let res = json!({
+                "errors": [],
+                "scanned": files_scanned,
+                "detector_responses": detector_responses,
+            });
+
+            println!("{}", serde_json::to_string_pretty(&res).unwrap());
         }
         parser::Commands::Metadata => {
             println!("{}", get_scanner_metadata());
@@ -87,7 +88,7 @@ fn main() {
 
 fn execute_detectors(
     files: &HashMap<String, String>,
-    rules: Option<Vec<String>>,
+    rules: Option<&Vec<String>>,
     load_lib: Option<std::path::PathBuf>,
 ) -> HashMap<String, Vec<DetectorResult>> {
     let codebase = build_codebase(files).unwrap();
@@ -107,7 +108,7 @@ fn execute_detectors(
     let selected_detectors: Vec<_> = available_detectors()
         .into_iter()
         .filter(|detector| {
-            if let Some(ref rules) = rules {
+            if let Some(rules) = rules {
                 rules.contains(&detector.id().to_string())
                     || (rules.len() == 1 && rules[0].eq_ignore_ascii_case("all"))
             } else {
@@ -127,7 +128,7 @@ fn execute_detectors(
 
 fn detector_result_to_json(
     errors: Vec<DetectorResult>,
-    project_root: &Option<std::path::PathBuf>,
+    project_root: Option<&PathBuf>,
 ) -> serde_json::Value {
     let mut json_errors = Vec::new();
     for error in errors {
@@ -145,7 +146,7 @@ fn detector_result_to_json(
     json!(json_errors)
 }
 
-fn relative_file_path(file_path: &str, project_root: &Option<std::path::PathBuf>) -> String {
+fn relative_file_path(file_path: &str, project_root: Option<&PathBuf>) -> String {
     if let Some(root) = project_root {
         if let Ok(relative_path) = std::path::Path::new(file_path).strip_prefix(root) {
             relative_path.to_string_lossy().to_string()
@@ -186,7 +187,7 @@ fn get_scanner_metadata() -> String {
             "report": {
                 "severity": detector.severity(),
                 "tags": detector.tags(),
-                "template": yml_string_to_json(detector.template())
+                "template": yml_string_to_json(&detector.template())
             }
         });
         detectors.push(json_detector);
@@ -202,6 +203,6 @@ fn get_scanner_metadata() -> String {
     serde_json::to_string_pretty(&scanner_json).unwrap()
 }
 
-fn yml_string_to_json(yml_string: String) -> Option<serde_json::Value> {
-    serde_yaml::from_str::<serde_json::Value>(&yml_string).ok()
+fn yml_string_to_json(yml_string: &str) -> Option<serde_json::Value> {
+    serde_yaml::from_str::<serde_json::Value>(yml_string).ok()
 }

detectors/build.rs

@@ -104,6 +104,7 @@ fn main() {
             let closing = template["closing"].as_str().unwrap_or_default();
             let type_def = format!(
                 r#"
+#[allow(clippy::manual_string_new)]
 impl DetectorReportTemplate for {type_name} {{
     fn id(&self) -> String {{ "{id}".to_string() }}
     fn uid(&self) -> String {{ "{uid}".to_string() }}
@@ -140,7 +141,7 @@ impl DetectorReportTemplate for {type_name} {{
 
     fs::write(&mod_file_path, mods).unwrap();
     let mut register_code = String::from(
-        "pub fn all_detectors() -> Vec<compact_security_detectors_sdk::detector::CompactDetector> {\n    vec![\n",
+        "#[must_use] pub fn all_detectors() -> Vec<compact_security_detectors_sdk::detector::CompactDetector> {\n    vec![\n",
     );
     for type_name in &detector_type_names {
         register_code.push_str(&format!("        Box::new({type_name}),\n",));

detectors/src/array_loop_bound_check.rs

@@ -43,7 +43,7 @@ compact_security_detectors_sdk::detector! {
                             };
                             errors.push(
                                 DetectorResult {
-                                    file_path: codebase.find_node_file(index_access.id).unwrap().fname,
+                                    file_path: codebase.find_node_file(index_access.id).unwrap().file_path,
                                     offset_start: index_access.location.offset_start,
                                     offset_end: index_access.location.offset_end,
                                     extra: {

detectors/src/assertion_error_message_verbose.rs

@@ -15,8 +15,7 @@ compact_security_detectors_sdk::detector! {
         for assert_node in codebase.list_assert_nodes() {
             if assert_node
                 .message()
-                .map(|msg| msg.trim().is_empty() || msg.len() < 3)
-                .unwrap_or(true)
+                .is_none_or(|msg| msg.trim().is_empty() || msg.len() < 3)
             {
                 let parent = codebase.get_parent_container(assert_node.id);
                 let mut parent_type = "circuit";
@@ -29,7 +28,7 @@ compact_security_detectors_sdk::detector! {
                     _ => String::new(),
                 };
                 errors.push(DetectorResult {
-                    file_path: codebase.find_node_file(assert_node.id).unwrap().fname,
+                    file_path: codebase.find_node_file(assert_node.id).unwrap().file_path,
                     offset_start: assert_node.location.offset_start,
                     offset_end: assert_node.location.offset_end,
                     extra: {

detectors/src/lib.rs

@@ -1,3 +1,4 @@
+#![warn(clippy::pedantic)]
 include!(concat!(env!("OUT_DIR"), "/mod_includes.rs"));
 include!(concat!(env!("OUT_DIR"), "/detector_report_templates.rs"));
 include!(concat!(env!("OUT_DIR"), "/register.rs"));

sdk/src/ast/builder.rs

@@ -1,4 +1,3 @@
-#![warn(clippy::pedantic)]
 use anyhow::{anyhow, bail, Ok, Result};
 use std::rc::Rc;
 use tree_sitter::Node;
@@ -2514,7 +2513,7 @@ mod tests {
         let mut codebase = Codebase::new();
         let ast = build_ast(&mut codebase, &root_node, content)?;
         let source_code_file = SourceCodeFile {
-            fname: fname.to_string(),
+            file_path: fname.to_string(),
             ast,
         };
         Ok(source_code_file)

sdk/src/ast/declaration.rs

@@ -1,4 +1,3 @@
-#![warn(clippy::pedantic)]
 use std::rc::Rc;
 
 use crate::{ast::expression::Expression, ast_enum, ast_nodes, ast_nodes_impl};
@@ -23,7 +22,6 @@ ast_enum! {
         @symbol Ledger(Rc<Ledger>),
         @scope Constructor(Rc<Constructor>),
         @scope Contract(Rc<Contract>),
-        @raw Definition(Definition), //TODO: why is it here?
         @symbol PatternArgument(Rc<PatternArgument>),
         StructPatternField(Rc<StructPatternField>),
     }

sdk/src/ast/definition.rs

@@ -1,4 +1,3 @@
-#![warn(clippy::pedantic)]
 use std::{rc::Rc, vec};
 
 use crate::{ast::statement::Statement, ast_enum, ast_nodes, ast_nodes_impl};

sdk/src/ast/directive.rs

@@ -1,4 +1,3 @@
-#![warn(clippy::pedantic)]
 use std::rc::Rc;
 
 use crate::{ast_enum, ast_nodes, ast_nodes_impl};

sdk/src/ast/literal.rs

@@ -1,4 +1,3 @@
-#![warn(clippy::pedantic)]
 use std::rc::Rc;
 
 use crate::{ast_enum, ast_nodes, ast_nodes_impl};