Automatically format Kotlin source files using ktlint before committing changes in a Git repository.

README.md

to use it:

1. install ktlint first: brew install ktlint - if not on mac, use different installation: https://github.com/pinterest/ktlint

2. modify your pre-commit file in .git folder

3. create .editorconfig file in root of your project

example config of .editorconfig:

[*.{kt,kts}]
indent_size = 2
indent_style = space

now commit ... ktlint will automatically format Kotlin source files using ktlint before committing changes in a Git repository.

pre-commit

#!/bin/sh

# Format Kotlin files with ktlint before committing
git diff --name-only -z --cached -- '*.kt' '*.kts' | \
xargs -0 sh -c 'ktlint -F "$@" || exit $?' ktlint

# If ktlint -F fails (returns non-zero), the commit will be aborted

# Re-add the files to stage the changes made by ktlint
git diff --name-only -z --cached -- '*.kt' '*.kts' | \
xargs -0 git add

# If you want to see what changes ktlint made before committing:
# git diff --cached

exit 0