feat: git hooks implementation

Author: JeneaVranceanu

.githooks/init_hooks.sh

@@ -0,0 +1,45 @@
+#!/bin/sh
+# Creates symlinks of hooks in .githooks directory in .git/hooks
+# If user already has hooks in .git/hooks then hooks from .githooks
+# will be added as separate files with different names and a command
+# to run these hooks will be added to the respective existing hooks
+# on the last line of the file.
+
+current_dir=${PWD##*/}
+
+if [ "$current_dir" != ".githooks" ]; then
+	cd .githooks
+fi
+
+shopt -s nullglob
+raw_githooks=(*)
+exclude=(init_hooks.sh)
+githooks=( "${raw_githooks[@]/$exclude}" )
+
+for hook in ${githooks[*]}
+do
+	git_hook_path="../.git/hooks/$hook"
+
+	web3swift_hook_comment="# web3swift git hook to perform actions like SwiftLint and codespell"
+	web3swift_hook_path="source $(pwd)/${hook}"
+
+	is_hook_linked=false
+
+	if test -f $git_hook_path; then
+		last_line=$( tac ${git_hook_path} | grep -m 1 -E '[^[:space:]]' )
+		if [ "$last_line" = "$web3swift_hook_path" ]; then
+			is_hook_linked=true
+		fi
+	else
+		touch $git_hook_path
+		chmod +x $git_hook_path
+		echo "#!/bin/sh\n" >> $git_hook_path
+	fi
+
+	if [ "$is_hook_linked" = false ] ; then
+		echo "$web3swift_hook_path" >> $git_hook_path
+		echo "${hook} is linked successfully."
+	else
+		echo "${hook} is already linked."
+	fi
+done

.githooks/pre-commit

@@ -0,0 +1,43 @@
+#!/bin/sh
+
+if ! command -v pip3 &> /dev/null
+then
+    >&2 echo "\033[31mpip3 could not be found. Please, install pip3 following the guide on https://pip.pypa.io/en/stable/installation/\033[0m"
+    exit 1
+fi
+
+codespell_out=$(pip3 show codespell | grep "Location")
+codespell_path=(${codespell_out//"Location: "/ })
+
+if [ -z "$codespell_path" ]
+then
+    echo "codespell not found. Installing codespell..."
+    pip3 install --upgrade pip
+	pip3 install codespell
+
+	codespell_out=$(pip3 show codespell | grep "Location")
+	codespell_path=(${codespell_out//"Location: "/ })
+	codespell_path="${codespell_path}/bin/codespell"
+else
+	codespell_path="${codespell_path}/bin/codespell"
+fi
+
+$codespell_path --count --ignore-words-list=ans,deriver,inout,packag --skip="*.js,*WordLists.swift" Sources/ Tests/ Package.swift CHANGELOG.md CONTRIBUTION.md README.md Web3Core.podspec Web3Swift.podspec
+
+if [ $? -eq 65 ]; then
+  echo "codespell returned exit code 65. Please, fix the errors."
+  exit 1
+fi
+
+if [ "$(uname -s)" = "Darwin" ]; then
+	export PATH="$PATH:/opt/homebrew/bin"
+
+	if ! command -v swiftlint &> /dev/null
+	then
+	    echo "swiftlint wasn't found. Installing it from Homebrew."
+	    brew install swiftlint
+	fi
+
+	swiftlint Sources
+	swiftlint Tests
+fi

README.md

@@ -188,6 +188,10 @@ $ ganache
 This will create a local blockchain and also some test accounts that are used throughout our tests.
 Make sure that `ganache` is running on its default port `8546`. To change the port in test cases locate `LocalTestCase.swift` and modify the static `url` variable.
 
+### Before you commit
+
+Please, run `.githooks/init_hooks.sh` to initialize git hooks that will do `codespell`, `swiftlint` and other checks. _Issues may arise with hooks on platforms other than Mac OS._
+
 ## Contribute
 Want to improve? It's awesome:
 Then good news for you: **We are ready to pay for your contribution via [@gitcoin bot](https://gitcoin.co/grants/358/web3swift)!**