waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: create nph.md (#2536)

This commit is contained in:
Ivan FB 2024-03-18 22:37:26 +01:00 committed by GitHub
parent 693a1778d1
commit a576e62401
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/contributors/nph.md Normal file
View File

@ -0,0 +1,26 @@
## nph - An opinionated Nim formatter
This prettifier tool is used to format the nwaku code base.
### VSCode Extension
https://marketplace.visualstudio.com/items?itemName=arnetheduck.vscode-nph
### GitHub
https://github.com/arnetheduck/nph
### Installation and configuration
1. Ask the [nwaku team](https://discord.com/channels/1110799176264056863/1111541184490393691) about the required `nph` version.
2. Download the desired release from _GitHub_ and place the binary in the PATH env var.
3. Add the following content into `~/.config/Code/User/settings.json`:
```
{
"[nim]": {
"editor.formatOnSave": true,
"editor.defaultFormatter": "arnetheduck.vscode-nph"
},
}
```
With that, every time a Nim file is saved, it will be formatted automatically.