-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
693a177
commit a576e62
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|