Have you ever wondered if you could launch a git hook that triggers a certain script that could help you do some task?. Me too!. Well, not really, until I needed it \ud83d\ude00<\/p>\n\n\n\n
In my case, I work with Xcode (iOS dev here, indeed) and it’s well known between us, iOS developers, that Xcode doesn’t provide a IDE with an autocorrect functionality, like others have. We do use a tool called “SwiftLint<\/strong>” wich triggers a lint in our project to enforce Swift style and conventions. And it also provides a “Autocorrect” command. <\/p>\n\n\n\n Problem is, that I wanted to autocorrect automatically, without me needing to run When you’re working on a big project with multiple devs at the same time, you need to improve somehow the way at least how autocorrect is triggered. I started learning about git hooks, and they seem very handy to do this kind of work. Ok, so, I started to think about steps on what I wanted and how could I achieve it:<\/p>\n\n\n\n Both of the steps above ended up in this final idea:<\/p>\n\n\n\n When editing or creating files, run swiflint autocorrect after a commit is made over these files.<\/strong><\/p>\n\n\n\n So, I ended creating the next files:<\/p>\n\n\n\n 1.- The bootstrap file which will copy the hook file inside .git\/hooks\/pre-commit path<\/strong>. I’ve called this file “bootstrap_hook<\/strong>.sh”<\/p>\n\n\n\n 2. And the code that will evaluate the files that are only in staging mode, so after you do a commit, these files will be autocorrected. If there’s anything to correct, then a new commit will be shown with these changes.<\/p>\n\n\n\n Now, to use it, the only thing you have to do is to run the bootstrap file and let git do his magic:<\/p>\n\n\n\n To run it: <\/p>\n\n\n\n I have copied these files in my github account if you want to clone it, fork it or pull request it \ud83d\ude00 https:\/\/github.com\/phynet\/Pre-Hook-Swiftlint-Autocorrect<\/a><\/p>\n","protected":false},"excerpt":{"rendered":" Have you ever wondered if you could launch a git hook that triggers a certain script that could help you do some task?. Me too!. Well, not really, until I needed it \ud83d\ude00 In my case, I work with Xcode (iOS dev here, indeed) and it’s well known between us, iOS developers, that Xcode doesn’t … swiftlint autocorrect<\/strong><\/code> everytime in terminal, since I tend to end up forgetting to do this kind of task manually.<\/p>\n\n\n\n\n#!\/usr\/bin\/env bash\n# Usage: scripts\/autocorrect\n\nset -eu\necho \"Configuring pre-commit hook...\"\nfile=\"..\/.git\/hooks\/pre-commit\"\npath=\".git\/hooks\"\necho $(pwd)\nrm -f $file\ncp -f pre-commit $file\necho \"Done coping pre-hook in $file\"<\/code><\/pre>\n\n\n\n#!\/bin\/bash\necho \"post-commit started\"\n# Run SwiftLint\nSTART_DATE=$(date +\"%s\")\n\nSWIFT_LINT=\/usr\/local\/bin\/swiftlint\n\n# Run SwiftLint for given filename\nrun_swiftlint() {\n local filename=\"${1}\"\n echo \"File is: ${filename}\"\n echo \"File with previous extension is: ${filename#*.}\"\n if [[ \"${filename##*.}\" == \"swift\" ]]; then\n if [[ \"${filename#*.}\" != \"generated.swift\" ]]; then\n echo \"Autocorrecting...\"\n ${SWIFT_LINT} autocorrect --path \"${filename}\"\n ${SWIFT_LINT} lint --path \"${filename}\"\n fi\n fi\n}\n\nif [[ -e \"${SWIFT_LINT}\" ]]; then\n echo \"SwiftLint version: $(${SWIFT_LINT} version)\"\n # Run only if not merging\n if ! git rev-parse -q --verify MERGE_HEAD; then \n # Run for both staged and unstaged files\n echo \"Enter merging\"\n git diff --name-only | while read filename; do run_swiftlint \"${filename}\"; done\n git diff --cached --name-only | while read filename; do run_swiftlint \"${filename}\"; done\n fi\nelse\n echo \"${SWIFT_LINT} is not installed. Please install it first from https:\/\/www.github.com\/realm\/SwiftLint\"\n exit 0\nfi\n\nEND_DATE=$(date +\"%s\")\n\nDIFF=$(($END_DATE - $START_DATE))\necho \"SwiftLint took $(($DIFF \/ 60)) minutes and $(($DIFF % 60)) seconds to complete.\"\n\necho \"post-commit finished\"<\/code><\/pre>\n\n\n\n$ sh bootstrap_hook.sh<\/code><\/p>\n\n\n\n