elide-dev/Elide Format

Check source formatting using Elide (google-java-format and ktfmt)

Trust Signals

name	description	required	default
formatter	Formatter to run: javaformat, ktfmt, or all	no	all
mode	Mode: check (default) or write	no	check
files	Files or directories to check (space or newline-separated paths). When omitted, sources are auto-detected by extension (.java for javaformat, .kt for ktfmt).	no	—
working-directory	Directory to run formatters from	no	${{ github.workspace }}
exclude	Files or patterns to exclude (space or newline-separated). Plain paths are matched as path segments; glob patterns (* and **) are also supported.	no	—
gjf-args	Extra arguments for google-java-format (appended after --)	no	—
ktfmt-args	Extra arguments for ktfmt (appended after --)	no	—
include-kts	Include .kts (Kotlin script) files when running ktfmt	no	false
fail-on-error	Fail the workflow when formatting check fails	no	true
telemetry	Enable anonymous error telemetry	no	true
output-mode	Output mode after the formatter runs: none (default), file (print affected file paths), diff (print unified diffs, check mode only), or command (print a fix command).	no	none
output-mode-diffs	When output-mode is diff, limit the number of files whose diffs are printed. If the number of affected files exceeds this limit, falls back to listing file paths instead. Must be a positive integer.	no	—
output-mode-command	When output-mode is command, print this string instead of a generated elide command. Intended for projects that have a pre-defined formatter command (e.g. a Makefile target).	no	—

name	description
result	Check result: success or failure
files-checked	Number of files checked
files-failed	Newline-separated list of files affected by the formatter: files that failed the format check (check mode) or were reformatted (write mode). Only set when output-mode is file.