Skip to content

Repository files navigation

fmtcheck

Release

A GitHub Action that enforces consistent formatting across your CI pipeline.

fmtcheck runs your language's canonical formatter in check mode and fails the build on any diff. Formatting debates stay out of code review because the machine settles them in CI.

Usage

- uses: libnudget/fmtcheck@main

Checks the repository root. To check a subdirectory:

- uses: libnudget/fmtcheck@main
  with:
    path: src

What it checks

  • Go source files (*.go) must match gofmt output.
  • .git and vendor directories are skipped.

Inputs

Name Required Default Description
path no . Directory to check.

Local development

The check can be run without Docker:

go run . --path .

Development

go vet ./...
go test ./...
gofmt -l .

License

MIT

About

GitHub Action for formatting checks.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages