https://github.com/clechasseur/rs-fmt-check

📋 GitHub Action for PR annotations with rustfmt suggestions
https://github.com/clechasseur/rs-fmt-check

github-actions rust rust-lang rustfmt

Last synced: about 2 months ago
JSON representation

📋 GitHub Action for PR annotations with rustfmt suggestions

• Host: GitHub
• URL: https://github.com/clechasseur/rs-fmt-check
• Owner: clechasseur
• License: mit
• Created: 2023-08-15T04:16:32.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2026-04-23T21:20:51.000Z (about 2 months ago)
• Last Synced: 2026-04-23T23:27:14.174Z (about 2 months ago)
• Topics: github-actions, rust, rust-lang, rustfmt
• Language: TypeScript
• Homepage:
• Size: 4.99 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# `rs-fmt-check` Action

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[![CI](https://github.com/clechasseur/rs-fmt-check/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/clechasseur/rs-fmt-check/actions/workflows/ci.yml)

> Rustfmt suggestions in your Pull Requests

This GitHub Action executes [`rustfmt`](https://github.com/rust-lang/rustfmt) and posts all suggestions as annotations for the pushed commit [2](#note-annotations-limit).

![Screenshot of a rustfmt suggestion displayed in the commit interface of GitHub](./.github/screenshot_fmt.png)

This GitHub Action is based on [clechasseur/rs-clippy-check](https://github.com/clechasseur/rs-clippy-check), which itself has been forked from [actions-rs/clippy-check](https://github.com/actions-rs/clippy-check).

See [LICENSE](LICENSE) for copyright attribution details.

## Example workflow

Note: this workflow uses [`actions-rust-lang/setup-rust-toolchain`](https://github.com/actions-rust-lang/setup-rust-toolchain) to install the most recent `nightly` rustfmt [1](#note-nightly-requirement).

```yaml

name: Rustfmt check

on: push

jobs:

  rustfmt_check:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - uses: actions-rust-lang/setup-rust-toolchain@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0

        with:

          toolchain: nightly

          components: rustfmt

      - uses: clechasseur/rs-fmt-check@v4.0.3

```

## Inputs

All inputs are optional.

| Name | Description                                                     | Type | Default |

| --- |-----------------------------------------------------------------| --- | --- |

| `toolchain` | Rust toolchain to use [1](#note-nightly-requirement) | string | `nightly` |

| `args` | Arguments for the `cargo fmt` command                           | string |         |

| `working-directory` | Directory where to perform the `cargo fmt` command              | string |         |

For extra details about the `toolchain` and `args` inputs, see [`rs-cargo` Action](https://github.com/clechasseur/rs-cargo#inputs).

## Release immutability

Starting with release 4.0.0, this GitHub action's releases will be marked as [immutable](https://docs.github.com/en/code-security/concepts/supply-chain-security/immutable-releases). This means that once a release is created, its tag cannot be modified in any way.

Previously, best practices for using GitHub actions in workflows were to pin the actions to a specific Git commit hash. With immutable releases, this is no longer necessary and the actual Git tag is safe to use. Because of this, starting with release 4.0.0, this GitHub action will **no longer provide a floating major version tag** (like `v4`, for example). To use a specific version of this action, pin it to the release tag (like `v4.0.0`).

## Notes

1 : This action currently relies on an unstable `rustfmt` feature (`emit json`) and as such, requires a `nightly` toolchain at the minimum. You should not change the value of the `toolchain` parameter unless you know the specified toolchain supports the feature correctly.

2 : Currently, GitHub sets a limit of 10 warning annotations per run (see [this page](https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28) for more information). So if there are more than 10 suggestions returned by `rustfmt`, only the first 10 will appear as PR annotations. The other suggestions will still appear in the check run summary (see [this one](https://github.com/clechasseur/rs-fmt-check/actions/runs/5886828621/attempts/1#summary-15965282231) for example).