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
Download binaries from the releases page.
nph can be also compiled or installed using nimble version v0.14.2+:
nimble -l setup
nimble build- VSCode (
ext install arnetheduck.vscode-nph) - NeoVim - Install neoformat in your neovim setup then add the nim formating option with nph with this option in init.vim
let g:neoformat_enabled_nim = ['nph'] - Zed Editor - Use this in your editor settings
"languages": {
"Nim": {
"formatter": {
"external": {
"command": "nph",
"arguments": ["-"]
}
}
}
}