Update aderyn.toml (#806)

.github/workflows/config.yml

@@ -0,0 +1,53 @@
+on: [push, pull_request, workflow_dispatch]
+
+name: Config
+
+concurrency:
+  group: ci-${{ github.ref }}-config
+  cancel-in-progress: true
+
+jobs:
+  reports-setup:
+    name:  Check Config
+    runs-on: ubuntu-latest
+    outputs:
+      rust-nightly: nightly-2025-01-01
+
+    steps:
+      - name: Install Foundry Toolchain
+        uses: foundry-rs/foundry-toolchain@v1.2.0
+
+      - name: Checkout Sources
+        uses: actions/checkout@v4
+
+      - name: Install Rust Nightly (2025-01-01)
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly-2025-01-01
+          override: true
+
+      - name: Cache Rust Dependencies
+        uses: Swatinem/rust-cache@v2
+
+      - name: Checkout Submodules
+        run: git submodule update --init --recursive
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Checkout Sources
+        uses: actions/checkout@v4
+
+      - name: Restore Rust Cache
+        uses: Swatinem/rust-cache@v2
+
+      - name: Initialize config 
+        run: |
+          mkdir config-test
+          cd config-test
+          cargo run -- init
+          diff ./aderyn.toml ../aderyn/templates/aderyn.toml

aderyn/templates/aderyn.toml

@@ -7,36 +7,36 @@ version = 1
 # Read the description carefully and uncomment the examples in each paragraph should you consider using them.
 
 # Base path for resolving remappings and compiling smart contracts, relative to workspace-root (directory in which the editor is open)
-# Most of the time, you want to point it to the directory containing foundry.toml or hardhat.config.js/ts. 
+# Most of the time, you want to point it to the directory containing foundry.toml or hardhat.config.js/ts.
 root = "."
 
 # Path of source directory containing the contracts, relative to root (above)
 # Aderyn traverse all the nested files inside scanning for vulnerabilities
 # If not specified, Aderyn will try to extract it from the framework that is being used. (Foundry / Hardhat)
-# That would be "contracts/" in case of Hardhat and in case of Foundry, it depends on foundry's config file and
-# many other factors like FOUNDRY_PROFILE environment variable, etc. used.
-# Please specify explicitly in case it's not Foundry / Hardhat project.
+# That would be "contracts/" in case of Hardhat and in case of Foundry, it depends on foundry.toml and
+# many other factors like FOUNDRY_PROFILE environment variable used when starting VS Code, etc.
+# Please feel free to always specify the values explicitly.
 # Example:
 # src = "src/"
 
 # Path segments of contract files to include in the analysis.
 # 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 "counters/Counter.sol", which will include only the file with the exact file.
+# Or it can be a full match like "src/counters/Counter.sol", which will include only the file with the exact path.
 # If not specified, all contract files in the source directory will be included.
 # Example:
-# include = ["counters/Counter.sol"]
-# include = []
+# include = ["src/counters/Counter.sol", "src/others/"]
+# include = ["/interfaces/"]
 
 # Path segments of contract files to exclude in the analysis.
 # 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.
+# Or it can be a full match like "src/counters/Counter.sol", which will exclude only the file with the exact path.
 # If not specified, no contract files will be excluded.
 # Example:
+# exclude = ["src/counters/Counter.sol", "src/others/"]
 # exclude = ["/interfaces/"]
-# exclude = []
 
 # Remappings used for compiling the contracts.
-# If not specified, Aderyn will try to derive the values from foundry's config file (if present.) 
-# That would be the result of calling `foundry remappings` 
+# If not specified, Aderyn will try to derive the values from foundry.toml (if present.)
+# That would be the result of calling `foundry remappings`
 # Example:
 # remappings = ["@oz/contracts=lib/openzeppelin-contracts/contracts"]