feat: add minor updates (#11)

* chore: exclude idea configuration files from VCS

Signed-off-by: Luca Georges Francois <luca@quartz.technology>

* docs: update implementation status table

Signed-off-by: Luca Georges Francois <luca@quartz.technology>

* feat: add empty mutation grapher

Signed-off-by: Luca Georges Francois <luca@quartz.technology>

---------

Signed-off-by: Luca Georges Francois <luca@quartz.technology>

Author: 0xpanoramix

.gitignore

@@ -14,3 +14,4 @@ Cargo.lock
 *.pdb
 
 .DS_Store
+.idea/

README.md

@@ -15,13 +15,13 @@ Cover by [DALL-E](https://openai.com/dall-e-2/).
 We want to help Solidity developers write better smart contracts.
 Various tools have been developed with this goal in mind: [Foundry](https://github.com/foundry-rs/foundry), [Slither](https://github.com/crytic/slither), [Heimdall](https://github.com/Jon-Becker/heimdall-rs) and so many more.
 
-The release of the [alloy-rs core librairies](https://github.com/alloy-rs/core) gave us the opportunity to experiment with the Solidity AST in Rust and we immediatly knew that we could build something upon it.
+The release of the [alloy-rs core libraries](https://github.com/alloy-rs/core) gave us the opportunity to experiment with the Solidity AST in Rust, and we immediately knew that we could build something upon it.
 
 We opted for a project able to evolve and scale. A software able to perform various scans on Solidity code - using the AST - and report valuable information to the developer.
 
 Soliris does not aim to be specialized in one single topic and should preferably hold scanners with different purposes: improving code syntax, giving more context about the contract's state, propose memory improvements and more.
 But we also acknowledge the limitations of the solution: it will never replace a compiler, nor a dedicated security tool such as Slither.
-It's more of a serious test demontrating the possibilities of [syn-solidity](https://github.com/alloy-rs/core/tree/main/crates/syn-solidity).
+It's more of a serious test demonstrating the possibilities of [syn-solidity](https://github.com/alloy-rs/core/tree/main/crates/syn-solidity).
 
 ## Development Status
 
@@ -34,9 +34,9 @@ Below is a list of the scanners implementation statuses:
 |    Name       	     | Goal                                                                                                         	 | Status 	 |
 |:-------------------:|----------------------------------------------------------------------------------------------------------------|:--------:|
 | Missing Comments 	  | Reports missing comments in your code.                                                                       	 |  ✅   	   |
-|  Unused Imports  	  | Reports unused `import` declarations in your contracts.                                                      	 |  ❌   	   |
 | Mutable Functions 	 | Reports functions able to mutate your contract's state.                                                      	 |  ✅   	   |
 | Mutable Variables 	 | Reports variables likely to mutate.                                                                          	 |  ✅   	   |
+|  Unused Imports  	  | Reports unused `import` declarations in your contracts.                                                      	 |  ❌   	   |
 | Mutation Grapher 	  | Creates a graph showing the variables likely to mutate connected to the places where they undergo mutations. 	 |  ❌   	   |
 | Struct Repacker  	  | Suggests an alternative way to define a struct such that it takes less storage slots.                        	 |  ❌   	   |
 

src/scanners/implementations/mod.rs

@@ -1,5 +1,6 @@
 pub mod missing_comments;
 pub mod mutable_functions;
 pub mod mutable_variables;
+pub mod mutation_grapher;
 pub mod struct_repacker;
 pub mod unused_imports;

src/scanners/implementations/mutation_grapher.rs

@@ -0,0 +1,14 @@
+use syn_solidity::Item;
+
+use crate::scanners::{memory::Metadata, Scanner};
+
+#[derive(Default)]
+pub struct MutationGrapher {}
+
+impl MutationGrapher {}
+
+impl Scanner for MutationGrapher {
+    fn execute(&self, _ast: &[Item], _metadata: &Metadata) {
+        println!("todo!")
+    }
+}

src/scanners/mod.rs

@@ -3,8 +3,8 @@ pub mod memory;
 
 use self::implementations::{
     missing_comments::MissingComments, mutable_functions::MutableFunctions,
-    mutable_variables::MutableVariables, struct_repacker::StructRepacker,
-    unused_imports::UnusedImports,
+    mutable_variables::MutableVariables, mutation_grapher::MutationGrapher,
+    struct_repacker::StructRepacker, unused_imports::UnusedImports,
 };
 use crate::scanners::memory::Metadata;
 use syn_solidity::Item;
@@ -37,6 +37,7 @@ impl Default for Registry {
                 Box::<MutableVariables>::default(),
                 Box::<MutableFunctions>::default(),
                 Box::<StructRepacker>::default(),
+                Box::<MutationGrapher>::default(),
             ],
         }
     }
@@ -60,7 +61,7 @@ mod tests {
     fn it_creates_default_scanners_registry() {
         let scanners_registry = Registry::default();
 
-        assert_eq!(scanners_registry.get_scanners().len(), 5)
+        assert_eq!(scanners_registry.get_scanners().len(), 6)
     }
 
     #[test]
@@ -69,6 +70,6 @@ mod tests {
 
         scanners_registry.register_scanner(Box::new(MockScanner::default()));
 
-        assert_eq!(scanners_registry.get_scanners().len(), 6)
+        assert_eq!(scanners_registry.get_scanners().len(), 7)
     }
 }

tests/contracts/MutableContract.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: UNLICENSED
+
+pragma solidity ^0.8.15;
+
+function IsAmethystBeautiful() public returns (bool) {
+    return true;
+}
+
+contract MutableContract {
+
+}