zeta-chain · mikelord007 · Jul 28, 2024 · coderabbitai · Jul 28, 2024 · coderabbitai
@@ -84,6 +84,7 @@
     "coverage": "forge clean && cross-env FOUNDRY_SRC='contracts/prototypes' forge coverage --report lcov",
     "docs": "forge doc",
     "generate": "yarn compile && ./scripts/generate_go.sh || true && ./scripts/generate_addresses.sh && yarn lint:fix",
+    "generate:diagrams": "./scripts/generate_uml_diagrams.sh",
     "lint": "npx eslint . --ext .js,.ts --ignore-pattern lib/",
     "lint:fix": "npx eslint . --ext .js,.ts,.json --fix --ignore-pattern coverage/ --ignore-pattern coverage.json --ignore-pattern lib/ --ignore-pattern out --ignore-pattern cache_forge/",
     "lint:sol": "solhint 'contracts/**/*.sol'",
@@ -96,5 +97,8 @@
     "worker": "npx hardhat run scripts/worker.ts --network localhost"
   },
   "types": "./dist/lib/index.d.ts",
-  "version": "0.0.8"
+  "version": "0.0.8",
+  "dependencies": {
+    "sol2uml": "^2.5.20"
+  }
 }
@@ -0,0 +1,48 @@
+#!/bin/bash
+
+# Directory containing the .sol files
+baseFolder="./contracts"
+folders=("/evm" "/zevm")
+
+# Output directory for the flattened files
+output_dir="./contracts"
+
+# Directory for the class diagrams
+diagram_folder="./contract-class-diagrams"
+
-folders=("/evm" "/zevm")
-
-# Output directory for the flattened files
-output_dir="./contracts"
-
-# Directory for the class diagrams
-diagram_folder="./contract-class-diagrams"
+# Ensure the diagram folder exists
+mkdir -p "$diagram_folder"
+
+folders=("/evm" "/zevm")
+
+# Output directory for the flattened files
+output_dir="./contracts"
+
+# Directory for the class diagrams
+diagram_folder="./contract-class-diagrams"
-folders=("/evm" "/zevm")
-
-# Output directory for the flattened files
-output_dir="./contracts"
-
-# Directory for the class diagrams
-diagram_folder="./contract-class-diagrams"
+# Ensure the diagram folder exists
+mkdir -p "$diagram_folder"
+
+folders=("/evm" "/zevm")
+
+# Output directory for the flattened files
+output_dir="./contracts"
+
+# Directory for the class diagrams
+diagram_folder="./contract-class-diagrams"
+# Loop through all .sol files in the contracts_dir
+for folder in "${folders[@]}"; do
+    contracts_dir="$baseFolder$folder"
+    echo "Processing folder: $contracts_dir"
+
+    for file in "$contracts_dir"/*.sol; do
+        # Check if any .sol files exist in the directory
+        if [[ ! -e "$file" ]]; then
+            echo "No .sol files found in $contracts_dir"
+            continue
+        fi
-# Loop through all .sol files in the contracts_dir
-for folder in "${folders[@]}"; do
-    contracts_dir="$baseFolder$folder"
-    echo "Processing folder: $contracts_dir"
-
-    for file in "$contracts_dir"/*.sol; do
-        # Check if any .sol files exist in the directory
-        if [[ ! -e "$file" ]]; then
-            echo "No .sol files found in $contracts_dir"
-            continue
-        fi
+# Loop through all .sol files in the contracts_dir
+for folder in "${folders[@]}"; do
+    contracts_dir="$baseFolder$folder"
+    echo "Processing folder: $contracts_dir"
+
+    for file in "$contracts_dir"/*.sol; do
+        # Check if any .sol files exist in the directory
+        if [[ ! -e "$file" ]]; then
+            echo "No .sol files found in $contracts_dir"
+            break
+            continue
+        fi
-# Loop through all .sol files in the contracts_dir
-for folder in "${folders[@]}"; do
-    contracts_dir="$baseFolder$folder"
-    echo "Processing folder: $contracts_dir"
-
-    for file in "$contracts_dir"/*.sol; do
-        # Check if any .sol files exist in the directory
-        if [[ ! -e "$file" ]]; then
-            echo "No .sol files found in $contracts_dir"
-            continue
-        fi
+# Loop through all .sol files in the contracts_dir
+for folder in "${folders[@]}"; do
+    contracts_dir="$baseFolder$folder"
+    echo "Processing folder: $contracts_dir"
+
+    for file in "$contracts_dir"/*.sol; do
+        # Check if any .sol files exist in the directory
+        if [[ ! -e "$file" ]]; then
+            echo "No .sol files found in $contracts_dir"
+            break
+            continue
+        fi
+
+        # Get the base name of the file (without path)
+        base_name=$(basename "$file")
+        echo "Processing file: $file"
+
+        # Construct the output file path
+        output_file="$output_dir/Flattened_$base_name"
+
+        # Run the flatten command
+        npx hardhat flatten "$file" > "$output_file"
+
+        # Check if the command was successful
+        if [ $? -eq 0 ]; then
+            echo "Successfully flattened $file to $output_file"
+        else
+            echo "Error flattening $file"
+        fi
-
-        # Get the base name of the file (without path)
-        base_name=$(basename "$file")
-        echo "Processing file: $file"
-
-        # Construct the output file path
-        output_file="$output_dir/Flattened_$base_name"
-
-        # Run the flatten command
-        npx hardhat flatten "$file" > "$output_file"
-
-        # Check if the command was successful
-        if [ $? -eq 0 ]; then
-            echo "Successfully flattened $file to $output_file"
-        else
-            echo "Error flattening $file"
-        fi
+
+        # Get the base name of the file (without path)
+        base_name=$(basename "$file")
+        echo "Processing file: $file"
+
+        # Construct the output file path
+        output_file="$output_dir/Flattened_$base_name"
+
+        # Run the flatten command
+        npx hardhat flatten "$file" > "$output_file"
+
+        # Check if the command was successful
+        if [ $? -eq 0 ]; then
+            echo "Successfully flattened $file to $output_file"
+        else
+            echo "Error flattening $file"
+            exit 1
+        fi
-
-        # Get the base name of the file (without path)
-        base_name=$(basename "$file")
-        echo "Processing file: $file"
-
-        # Construct the output file path
-        output_file="$output_dir/Flattened_$base_name"
-
-        # Run the flatten command
-        npx hardhat flatten "$file" > "$output_file"
-
-        # Check if the command was successful
-        if [ $? -eq 0 ]; then
-            echo "Successfully flattened $file to $output_file"
-        else
-            echo "Error flattening $file"
-        fi
+
+        # Get the base name of the file (without path)
+        base_name=$(basename "$file")
+        echo "Processing file: $file"
+
+        # Construct the output file path
+        output_file="$output_dir/Flattened_$base_name"
+
+        # Run the flatten command
+        npx hardhat flatten "$file" > "$output_file"
+
+        # Check if the command was successful
+        if [ $? -eq 0 ]; then
+            echo "Successfully flattened $file to $output_file"
+        else
+            echo "Error flattening $file"
+            exit 1
+        fi
+
+        # Run the sol2uml command
+        npx sol2uml class "$output_file" -f png -o "$diagram_folder/$folder/$base_name.png"
+
+        # Remove the flattened file
+        rm "$output_file"
-        # Run the sol2uml command
-        npx sol2uml class "$output_file" -f png -o "$diagram_folder/$folder/$base_name.png"
-
-        # Remove the flattened file
-        rm "$output_file"
+        # Run the sol2uml command
+        npx sol2uml class "$output_file" -f png -o "$diagram_folder/$folder/$base_name.png"
+
+        # Check if the command was successful
+        if [ $? -eq 0 ]; then
+            echo "Successfully generated UML diagram for $file"
+        else
+            echo "Error generating UML diagram for $file"
+            exit 1
+        fi
+
+        # Remove the flattened file
+        rm "$output_file"
-        # Run the sol2uml command
-        npx sol2uml class "$output_file" -f png -o "$diagram_folder/$folder/$base_name.png"
-
-        # Remove the flattened file
-        rm "$output_file"
+        # Run the sol2uml command
+        npx sol2uml class "$output_file" -f png -o "$diagram_folder/$folder/$base_name.png"
+
+        # Check if the command was successful
+        if [ $? -eq 0 ]; then
+            echo "Successfully generated UML diagram for $file"
+        else
+            echo "Error generating UML diagram for $file"
+            exit 1
+        fi
+
+        # Remove the flattened file
+        rm "$output_file"
+    done
+done