Feat: aderyn init (#722)

Co-authored-by: Alex Roan <[email protected]>

aderyn/src/lib.rs

@@ -1,8 +1,17 @@
 use aderyn_driver::detector::{get_all_detectors_names, get_issue_detector_by_name, IssueSeverity};
 use semver::Version;
 use serde_json::Value;
+use std::{fs::File, io::Write, path::PathBuf, str::FromStr};
 use strum::IntoEnumIterator;
 
+pub fn create_aderyn_toml_file_at(directory: String) {
+    let aderyn_toml_path = PathBuf::from_str(&directory).unwrap().join("aderyn.toml");
+    let mut file = File::create_new(aderyn_toml_path.clone()).expect("File already exists!");
+    file.write_all(include_bytes!("../templates/aderyn.toml"))
+        .expect("To write contents into aderyn.toml");
+    println!("Created aderyn.toml at {}", aderyn_toml_path.display());
+}
+
 mod panic;
 
 pub fn initialize_niceties() {

aderyn/src/main.rs

@@ -1,6 +1,6 @@
 use aderyn::{
-    aderyn_is_currently_running_newest_version, initialize_niceties, lsp::spin_up_language_server,
-    print_all_detectors_view, print_detail_view,
+    aderyn_is_currently_running_newest_version, create_aderyn_toml_file_at, initialize_niceties,
+    lsp::spin_up_language_server, print_all_detectors_view, print_detail_view,
 };
 use aderyn_driver::driver::{self, Args};
 
@@ -17,6 +17,10 @@ pub struct CommandLineArgs {
     #[arg(default_value = ".")]
     root: String,
 
+    /// Initialize aderyn.toml in [ROOT] which hosts all the configuration to override defaults
+    #[arg(long)]
+    init: bool,
+
     /// Path to the source contracts. If not provided, the ROOT directory will be used.
     ///
     /// For example, in a foundry repo:
@@ -101,6 +105,16 @@ fn main() {
         return;
     }
 
+    if cmd_args.root == "init" {
+        create_aderyn_toml_file_at(".".to_string());
+        return;
+    }
+
+    if cmd_args.init {
+        create_aderyn_toml_file_at(cmd_args.root);
+        return;
+    }
+
     let mut args: Args = Args {
         root: cmd_args.root,
         output: cmd_args.output,

aderyn/templates/aderyn.toml

@@ -0,0 +1,34 @@
+# Aderyn Configuration File
+# This is a sample configuration for Aderyn
+
+# The root directory of smart contracts
+# root = "."
+
+# By default, aderyn will try to extract the following values based on the framework that is being used.
+# However, if you want to be explicit consider mentioning them.
+
+# The source directory containing the Solidity contracts.
+# This is often "contracts/" or "src/"
+# src = "src/"
+
+# Contract files to include in the analysis.
+# This is a list of strings representing the file paths of the contracts to include.
+# It can be a partial match like "/interfaces/", which will include all files with "/interfaces/" in the file path.
+# Or it can be a full match like "Counter.sol", which will include only the file with the exact file.
+# If not specified, all contract files in the source directory will be included.
+# Example:
+# include = ["Counter.sol"]
+# include = []
+
+# Contract files to exclude from the analysis.
+# This is a list of strings representing the file paths of the contracts to exclude.
+# It can be a partial match like "/interfaces/", which will exclude all files with "/interfaces/" in the file path.
+# Or it can be a full match like "Counter.sol", which will exclude only the file with the exact file.
+# If not specified, no contract files will be excluded.
+# Example:
+# exclude = ["/interfaces/"]
+# exclude = []
+
+## Remappings used for compiling the contracts.
+# Example:
+# remappings = ["@oz/contracts=lib/openzeppelin-contracts/contracts"]