My (very) basic script tool

[juliancabmar]

Bash Script tool to analyze solidity files with cloc and sort by lines of code

Hi everyone!

I wanted to share a small bash script I created that might be useful for those working with Solidity projects. This script, scloc.sh, analyzes Solidity files in a specified directory using cloc and outputs a summary sorted by the number of lines of code in ascending order (good for Tincho method).

How It Works:

• It takes a directory as an argument.
• It uses cloc to count lines of code in Solidity files.
• The output is formatted into a table showing a "check" field, the number of lines of code and the corresponding file path.
• The file names are formatted for link the real file based in the markdown links "[](FilePath)"

Usage:

$ ./scloc.sh [dir path]

Output example (actually I'm doing thunder-loan):

 Checked | Code | Files
    -    | 4    | [](./src/interfaces/IPoolFactory.sol)
    -    | 4    | [](./src/interfaces/IThunderLoan.sol)
    -    | 4    | [](./src/interfaces/ITSwapPool.sol)
    -    | 13   | [](./src/interfaces/IFlashLoanReceiver.sol)
    -    | 23   | [](./src/protocol/OracleUpgradeable.sol)
    -    | 65   | [](./src/protocol/AssetToken.sol)
    -    | 172  | [](./src/upgradedProtocol/ThunderLoanUpgraded.sol)
    -    | 176  | [](./src/protocol/ThunderLoan.sol)

Then, I this help me to check the audited files and navigate between them.

 Checked | Code | Files
    +    | 4    | [](./src/interfaces/IPoolFactory.sol)
    +    | 4    | [](./src/interfaces/IThunderLoan.sol)
    +    | 4    | [](./src/interfaces/ITSwapPool.sol)
    -    | 13   | [](./src/interfaces/IFlashLoanReceiver.sol)
    -    | 23   | [](./src/protocol/OracleUpgradeable.sol)
    -    | 65   | [](./src/protocol/AssetToken.sol)
    -    | 172  | [](./src/upgradedProtocol/ThunderLoanUpgraded.sol)
    -    | 176  | [](./src/protocol/ThunderLoan.sol)

Here is the code:

#!/bin/bash

# Display help message
if [[ "$1" == "--help" || -z "$1" ]]; then
  echo "Usage: scloc.sh [directory]"
  echo "This script analyzes Solidity files with cloc in the specified directory and outputs a summary sorted by the amount of lines of code (increasing order)."
  echo "Options:"
  echo "  --help    Show this help message and exit."
  exit 0
fi

echo -e " Checked | Code\t| Files"
cloc --by-file --csv "$1" | grep "Solidity" | cut -d ',' -f 5,2 | sort -n -t ',' -k 2 | sed 's/^\(.*\),\(.*\)$/    -    | \2\t| \[\]\(\1\)/'

Is some silly but practical for me. Good luck to all 👋

[EngrPips]

Thanks for sharing this with us buddy, we appreciate it.