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.

Usage

- uses: jrouly/scalafmt-native-action@v2
  with:
    # Optional: Which version of scalafmt-native to use.
    # Default: 3.5.8
    version: '3.5.8'

    # 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@v2

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.