Instantly share code, notes, and snippets.

Embed
What would you like to do?
Git Pre-Commit hook with SwiftLInt
#!/bin/bash
#Path to swiftlint
SWIFT_LINT=/usr/local/bin/swiftlint
#if $SWIFT_LINT >/dev/null 2>&1; then
if [[ -e "${SWIFT_LINT}" ]]; then
count=0
for file_path in $(git ls-files -m --exclude-from=.gitignore | grep ".swift$"); do
export SCRIPT_INPUT_FILE_$count=$file_path
count=$((count + 1))
done
##### Check for modified files in unstaged/Staged area #####
for file_path in $(git diff --name-only --cached | grep ".swift$"); do
export SCRIPT_INPUT_FILE_$count=$file_path
count=$((count + 1))
done
##### Make the count avilable as global variable #####
export SCRIPT_INPUT_FILE_COUNT=$count
echo "${SCRIPT_INPUT_FILE_COUNT}"
##### Lint files or exit if no files found for lintint #####
if [ "$count" -ne 0 ]; then
echo "Found lintable files! Linting and fixing the fixible parts..."
$SWIFT_LINT autocorrect --use-script-input-files --config .swiftlint.yml #autocorrects before commit.
else
echo "No files to lint!"
exit 0
fi
RESULT=$?
if [ $RESULT -eq 0 ]; then
echo ""
echo "Violation found of the type WARNING! Must fix before commit!"
else
echo ""
echo "Violation found of the type ERROR! Must fix before commit!"
fi
exit $RESULT
else
#### If SwiftLint is not installed, do not allow commit
echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
echo "If you have Homebrew, you can directly use `brew install swiftlint` to install SwiftLint"
exit 1
fi
@fabb

This comment has been minimized.

fabb commented Jul 8, 2018

Good idea to check only changed files!
Question: why check unstaged files that won‘t be committed as well (git ls-files -m)?

@fabb

This comment has been minimized.

fabb commented Jul 9, 2018

The script is not ideal for several reasons:

  1. It checks both staged and unstaged files, this might not always be wanted
  2. If a file has both staged and unstaged changes (e.g. only add some hunks of all the changes in a file), then this script will add the file twice
  3. It includes deleted files which will make swiftlint crash - --diff-filter=d can be used on git diff to exclude deleted staged files - for git ls-files i'm not sure how to hide removed files
  4. The script autocorrects also unstaged files, even if the commit succeeds
  5. It would not work correctly if for example I make stage some changes to a file, and then move the file (unstaged)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment