style: nph formatting

[AuHau]

This PR implements code formatting using nph of folders codex/ and tests/.

It is enforced on CI level using https://github.com/arnetheduck/nph-action. Nice thing it can suggest formatting changes in case somebody forgets to format its PR before submitting it.

More details on how to use it can be found in README: https://github.com/codex-storage/nim-codex/pull/1067/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R60

This work is based on nwaku implementation of nph - so kudos to them!

[benbierens]

It seems to have a precommit hook and a workflow checking step. Even if the style itself isn't perfect, I think this is still a very good thing to have.

[gmega]

Yes we know you just want to have your name amongst the contributors with the most lines added/deleted, @AuHau ...

[gmega]

On a more serious note: I'm happy to have nph, but I think we need to make sure versions match locally and in CI.

[AuHau]

@emizzle and @gmega - CI action pinned. Please re-review ;-)

[emizzle]

LGTM

[arnetheduck]

committer

see https://github.com/arnetheduck/nph/blob/master/format-git-repo.sh#L12 for how to not become the target of future git blame - after all, the last to change the code is the one that is responsible for it's maintenance until the next sucker comes around ;)

[AuHau]

committer

see arnetheduck/nph@master/format-git-repo.sh#L12 for how to not become the target of future git blame - after all, the last to change the code is the one that is responsible for it's maintenance until the next sucker comes around ;)

That is a super cool tip! Thanks will employ it ;-)

[arnetheduck]

something to be mindful of: when you merge this with the usual non-fast-forward squash merge, the commit hashes will change invalidating git-blame-ignore-revs - better merge manually or create ignore-revs separately

[marcinczenko]

Is this "Format On Save" or is it nim.lintOnSave? There is also editor.formatOnSave option, and perhaps it also has to be set to true, but formatOnSave is just a generic VSCode option if I remember correctly.

Also, you could consider adding a link to the NimLang to remove any doubts about the extension.

[AuHau]

Yeah it is, it is nim.formatOnSave. Will clarify though - thanks.

[marcinczenko]

Ok, I did some tests. So it looks like nim.lintOnSave is actually depreciated and nim.formatOnSave does exist on NimLang extension. Setting either editor.formatOnSave or nim.formatOnSave does the job (one of them need to be set to true, the order does not seem to matter).