pre-commit-detekt

pre-commit-detekt is a pre-commit hook for detekt. pre-commit-detekt does not require pre-installation of detekt-cli.

Quick start

Append the following to your .pre-commit-config.yaml:

# .pre-commit-config.yaml
repos:
  # ....
  - repo: https://github.com/quwac/pre-commit-detekt
    rev: v1.23.4  # Set detekt version >= v1.23.4. See https://github.com/detekt/detekt/tags
    hooks:
      - id: detekt-docker

Configuration

pre-commit-detekt supports all the options of detekt. You can pass them as arguments to the hook.

# .pre-commit-config.yaml
repos:
  # ....
  - repo: https://github.com/quwac/pre-commit-detekt
    rev: v1.23.4
    hooks:
      - id: detekt-docker
        args: [
          --all-rules,
          --auto-correct,
          --config,
          config/detekt.yml,  # Make detekt.yml in `./config` directory.
          --plugins,
          detekt-plugins/detekt-formatting-1.23.4.jar,  # Download detekt-formatting-1.23.4.jar in `./detekt-plugins` directory.
          --report,
          html:detekt.html
        ]

You can also run pre-commit-detekt in your host environment. Replace the id from detekt-docker with detekt. detekt requires Java installation.

# .pre-commit-config.yaml
repos:
  # ....
  - repo: https://github.com/quwac/pre-commit-detekt
    rev: v1.23.4
    hooks:
      - id: detekt  # 👈 HERE!
        args: [
          --all-rules,
          --auto-correct,
          --config,
          config/detekt.yml,
          --plugins,
          detekt-plugins/detekt-formatting-1.23.4.jar,
          --report,
          html:detekt.html
        ]