prosefmt
prosefmt is the simplest text formatter for making your files look correct. No complex rules,
no massive configuration files — just clean text.
Contents
Overview
Over the years, I’ve used to format files with text or code in a specific way, like removing trailing spaces or adding a new line at the end. If a code formatter is used in a project, it usually handles these tasks. However, some projects simply do not have one, and introducing a formatter can be a significant challenge. And even when a formatter is configured, some project files are still ignored because formatters are trained for specific languages and file types.
prosefmt is the simplest formatter for any text files. If the project does not have a formatter, it could
be the first one you integrate. If the project has some, it could be a useful addition.
prosefmt is designed to process any text files while automatically ignoring binary files (which contain
null bytes or control characters). The tool does not use configuration files; all settings are specified
via the command line with sensitive defaults. Additionally, for security reasons, files are only overwritten
when the write command is explicitly issued.
The tool supports the following rules:
- PF1 - a file must end with exactly one newline. Both LF and CRLF line endings are supported. The tool preserves the detected style when writing.
- PF2 - no trailing space(s) or tab(s) at the end of a line.
Getting Started
Installation
Install Script
Download and install the latest release:
curl -fsSL https://raw.githubusercontent.com/extsoft/prosefmt/main/install.sh | sh
Install to a custom directory:
curl -sSL https://raw.githubusercontent.com/extsoft/prosefmt/main/install.sh | sh -s -- -d ~/.local/bin
Install a specific version:
curl -sSL https://raw.githubusercontent.com/extsoft/prosefmt/main/install.sh | sh -s -- -v v1.0.0
mise
mise use github:extsoft/prosefmt
Go Install
go install github.com/extsoft/prosefmt@latest
Usage
For safety reasons (to prevent any unwated file changes), please run the check command first.
prosefmt check some/path some.file
The output wll show what files will be updated and why. Once you ready to format, run
prosefmt write some/path some.file
CLI Reference
Synopsis
prosefmt [command] [path...]
Pass at least one file or directory; directories are scanned recursively. With no command, runs check by default (report only). Use the write command to apply fixes in place. Output options (--silent, --compact, --verbose) apply only to the check and write commands.
Commands
check
Check files and report issues. Scan paths and report issues to stdout. Exit code is 1 if any issue is found, 0 otherwise. This is the default when no command is specified (e.g. prosefmt path...).
Output (only for this command):
- –silent: No standard output printed. Exit code is still 1 when issues are found.
- –compact: Show report / formatted or errored files (default when no output flag is set).
- –verbose: Print debug output on stderr (steps, scanning summary, rules per file, timing).
write
Write fixes in place. Files with issues are modified on disk. Prints how many files were written and lists each path; exit code is 0.
Output (only for this command): same as check — --silent, --compact, --verbose.
version
Print the version number. Run: prosefmt version.
Output (check and write only)
Check prints a compact report: one line per issue as file:line:col: rule: message, grouped by file then rule; then a summary line N file(s) scanned, M issue(s).
By default output is compact: report (or “No text files found.”, or “Wrote N file(s):” plus paths in write mode). If multiple output flags are set, the noisiest wins (verbose > compact > silent).
--silent
No standard output printed. Exit code is still 1 when issues are found in check mode.
--compact
Show formatted or errored files: report in check mode, “No text files found.” when applicable, “Wrote N file(s):” plus one path per line in write mode. Default when no output level flag is set.
--verbose
Print debug output: steps, scanning summary, scanner accepted/rejected with reasons, rules per file, write steps, and timing on stderr.
Development
Install mise (dev tool version manager), then run mise run init in the repo so the project’s tools and env are activated. See mise docs for install and usage.
This project uses hk for code checks and git hooks. Use mise run check or mise run fix to check or autofix.
mise run build builds the CLI binary.
License
This project is licensed under the MIT License. See the LICENSE file for details.