nph
is an opinionated source code formatter for the Nim language, aiming to
take the drudgery of manual formatting out of your coding day.
Following the great tradition of black
,
prettier
, clang-format
and other AST-based formatters, it discards existing styling to create a
consistent and beautiful codebase.
Documentation is available here.
Install nph
, then run it on some files:
# Format the given files in-place
nph file0.nim file1.nim
# Format the given files, writing the formatted code to /tmp
nph file0.nim file1.nim --outdir:/tmp
# Format an entire directory
nph src/
# Use --check to verify that a file is formatted as `nph` would - useful in CI
nph --check somefile.nim || echo "Not formatted!"
# You can format stuff as part of a pipe using `-` as input:
echo "echo 1" | nph -
More information about features and style available from the documentation
Binaries are available from the releases page on Github.
nph
can be also compiled or installed using nimble
v0.16.4+:
# Install globally
nimble install nph
# Alternatively, build in source folder:
nimble setup -l
nimble build
See the installation instructions in the manual for more details.
Editor integrations are described in the manual.
Check out the companion Github Action for a convenient CI option!