Add Shell Linting

[jaydrogers]

👉 Describe the problem

There are areas of the code that could be standardized and automatically linted.

👥 Problem evidence & reach

Related Issues & PRs:

• Indent with 4 spaces #16
• Shell is also a script language #15

🥰 Describe the "impact" on users?

It will make developers happier and easy to collaborate with.

🏆 How to solve this problem

• Implement Shellcheck in CI
• move curly brace to a separate line
• add shebang and script headers
• move things without side effect (function declaration are not executed!) to the top
• nice, decorative comments could be removed, use descriptive function names instead

💯 How do we validate the problem is solved?

• GitHub Actions has automated linting
• A standard is created for shell linting

[jaydrogers]

Adding a note

Possible shellcheck script could be:

#!/bin/bash
# A script to run ShellCheck on specified directories and files

# First, check the script in the bin directory
echo "Linting /bin/spin"
shellcheck bin/spin

# Now, find all .sh files in the lib directory and run ShellCheck on them
echo "Linting all .sh files in /lib/actions"
find lib/actions -type f -name "*.sh" -exec shellcheck {} +

echo "All scripts have been linted."