scalafmt-native GitHub Action

GitHub action to run scalafmt-native.

Spend more time discussing important issues in code review and less time on code style. Scalafmt formats code so that it looks consistent between people on your team.

Integrate Scala code formatting in your GitHub actions workflows. By using the native scalafmt image, this action typically completes in two to three seconds for moderately sized codebases.

Caution

Versions of this action prior to v4 are likely to be broken due to changes in upstream scalafmt-native. It is recommended to upgrade to v4 or newer.

Usage

- uses: jrouly/scalafmt-native-action@v4
  with:
    # Optional: Which version of scalafmt-native to use.
    # Default: Read from .scalafmt.conf, otherwise '3.7.17'.
    # Note: If .scalafmt.conf is not located in the repository root,
    #       you must specify the version here.
    version: '3.7.17'

    # Optional: Arguments to be passed to scalafmt-native.
    # Default: --list
    arguments: '--list'

Default usage

Without any parameters, this action will run scalafmt-native --list. If any non-conforming files are present, they will be printed and the command will exit with a failure. Otherwise it will silently exit with success.

- uses: jrouly/scalafmt-native-action@v4

OS compatibility

scalafmt-native is not available for Windows. Can only be run on Linux and MacOS.

Credits

Inspired by the design and usage patterns of olafurpg/setup-scala.

Similar to openlawteam/scalafmt-ci but does not pin the version of the action to a specific version of scalafmt.

Similar to AvaPL/scalafmt-native-formatter but leverages the GitHub actions TypeScript SDK for logging and testing.

Releasing

Merging a branch to main triggers the release job from the CI workflow. This job builds a release candidate and force pushes a commit to the release branch. Once ready to be released, a GitHub release can be created off that branch.