Feature: IDEA: trigger ktfmt check on attempted commit

[isXander]

It would be cool if ktfmt executed a check when a user attempts to commit to VCS (maybe as a warning).

Or even better, runs the formatter itself when you attempt to commit.

I have countless times committed my code to then fail on CI because I forget to run ktfmt.

[ColtonIdle]

You can write a git precommit hook to just run ktfmt before you can even commit locally.

You could probably copy it fromt this ktlin gradle plugin repo: https://github.com/JLLeitschuh/ktlint-gradle#additional-helper-tasks

[cortinico]

If you use ktfmt-gradle there is a section about using ktfmt as a pre-commit hook here:https://github.com/cortinico/ktfmt-gradle#using-with-a-pre-commit-hook-

[JavierSegoviaCordoba]

If you are using the IDEA plugin it will reformat the code of all changed files if you have the checkbox selected.

[0x26res]

For pre-commit users, I've recently added support for ktfmt in the language-formatter-pre-commit-hooks. It doesn't require gradle, you just need python and java installed in your dev environment.

See the MR: macisamuele/language-formatters-pre-commit-hooks#196

Here's a sample .pre-commit-config.yaml

repos:
  - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
    rev: v2.12.0
    hooks:
      - id: pretty-format-kotlin
        files: "^.*.(kts|kt)$"
        name: ktfmt
        args: [--ktfmt, --ktfmt-style=google, --autofix]

Thanks @macisamuele for helping setting it up.

[hick209]

Closing as this is a solved issue