style: formatting

[evilrobot-01]

Improves formatting and checks through standardisation. The main goal is automation as much as possible, whether possible in the dev environment or automated via CI.

CI

This draft adds the following checks only (i.e. no auto-fixes).

• formatting checks of Rust files using Nightly, as it provides a number of additional useful configuration options (.rustfmt.toml)
  • can be run locally via cargo +nightly fmt --all or configured in editor/ide or commit hooks
• formatting checks of Cargo manifests using taplo
  • can be run locally with taplo format --check and taplo format to fix
• formatting and checks of features using zepter
  • can be run locally with zepter format features and zepter format features --fix to fix

Manifest formatting is generally alphabetically by 'region', inline with Rust imports which are alphabetical and grouped by source (std library, external, internal). I feel the latter does indeed have some benefit over one large grouping. Subjective grouping of imports can make it difficult for others to immediately understand how things should be grouped and applying accordingly. Using a standard approach eliminates this concern.

Local

A pre-push git hook is included at ./githooks and needs to be manually installed via the instructions in the readme at the same location. It currently only runs the Rust formatting checks as listed above, but can be extended to include the other checks noted as well.

A pre-commit hook could also be added to auto-format, but most editors/ides probably allow this to be set on save so re-running it all again on each commit might be overkill.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 0% with 20 lines in your changes missing coverage. Please review.

Project coverage is 6.40%. Comparing base (c4e2a6d) to head (8f4c831).

Files	Patch %	Lines
node/src/command.rs	0.00%	16 Missing ⚠️
runtime/devnet/src/config/xcm.rs	0.00%	2 Missing ⚠️
runtime/testnet/src/config/xcm.rs	0.00%	2 Missing ⚠️

@@          Coverage Diff          @@
##            main    #184   +/-   ##
=====================================
  Coverage   6.40%   6.40%           
=====================================
  Files         27      27           
  Lines       1997    1997           
  Branches    1997    1997           
=====================================
  Hits         128     128           
  Misses      1869    1869           

Files	Coverage Δ
node/src/rpc.rs	0.00% <ø> (ø)
node/src/service.rs	0.00% <ø> (ø)
primitives/src/storage_keys.rs	0.00% <ø> (ø)
runtime/common/src/lib.rs	0.00% <ø> (ø)
runtime/devnet/src/config/contracts.rs	60.00% <ø> (ø)
runtime/devnet/src/config/proxy.rs	0.00% <ø> (ø)
runtime/devnet/src/extensions.rs	0.00% <ø> (ø)
runtime/devnet/src/lib.rs	3.89% <ø> (ø)
runtime/devnet/src/weights/paritydb_weights.rs	73.33% <ø> (ø)
runtime/devnet/src/weights/rocksdb_weights.rs	73.33% <ø> (ø)
... and 9 more

[Daanvdplas]

All looks perfect to me! cargo +nightly fmt already seems to do a lot of things! Zepter and Taplo will definitely come in handy for the pop cli repo as well!

Again, this gives me so much piece of mind! Thank you very much ❤️

[Daanvdplas]

Very excited! Thanks for the effort you put into this. I think it will have a very positive impact on our development output as a team!

[al3mart]

I have open a PR to extend the githooks with TOML and features formating in #229.

Happy to rebase that PR if we want to merge this first! 👍

[evilrobot-01]

I have open a PR to extend the githooks with TOML and features formating in #229.

Happy to rebase that PR if we want to merge this first! 👍

As this has been sitting for a week, my suggestion would be to get this merged and then treat that as a separate PR. I have not tested that locally so not sure how much additional time it adds running the checks prior to a push?