ci: setup bulloak in CI

.github/workflows/tests.yml

@@ -127,7 +127,7 @@ jobs:
         run: yarn test:integration
 
   lint:
-    name: Lint Commit Messages
+    name: Static Analysis
     runs-on: ubuntu-latest
 
     steps:
@@ -148,7 +148,15 @@ jobs:
           node-version: 20.x
           cache: 'yarn'
 
+      - name: Install bulloak 
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: bulloak
+
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
 
-      - run: yarn lint:check
+      - run: yarn lint:check
+
+      - name: Run bulloak check
+        run: yarn lint:bulloak

package.json

@@ -18,6 +18,7 @@
     "lint:check": "yarn lint:sol-tests && yarn lint:sol-logic && forge fmt --check",
     "lint:fix": "sort-package-json && forge fmt && yarn lint:sol-tests --fix && yarn lint:sol-logic --fix",
     "lint:natspec": "npx @defi-wonderland/natspec-smells --config natspec-smells.config.js",
+    "lint:bulloak": "find test/unit -name '*.tree' | xargs bulloak check",
     "lint:sol-logic": "solhint -c .solhint.json 'src/**/*.sol' 'script/**/*.sol'",
     "lint:sol-tests": "solhint -c .solhint.tests.json 'test/**/*.sol'",
     "prepare": "husky install",

test/unit/Greeter.tree

@@ -1,4 +1,4 @@
-Greeter::constructor
+UnitGreeter::constructor
 ├── when passing valid greeting string
 │   ├── it deploys
 │   ├── it sets the greeting string
@@ -8,18 +8,18 @@ Greeter::constructor
     └── it reverts
 
 
-Greeter::greet
+UnitGreeter::greet
 └── when called
     ├── it returns the greeting string
     └── it returns the token balance of the contract
 
 
-Greeter::setGreeting
+UnitGreeter::setGreeting
 ├── when called by the owner
 │   ├── when passing a valid greeting string
 │   │   ├── it sets the greeting string
 │   │   └── it emit GreetingSet
 │   └── when passing an empty greeting string
 │       └── it reverts
 └── when called by a non-owner
-    └── it reverts
+    └── it reverts