Add linter to CI and applied some fixes #35
Conversation
There was a problem hiding this comment.
Looks good! Few minor comments:
I applied the automatic fixes. There's still one more error: https://rust-lang.github.io/rust-clippy/master/index.html#/module_inception, which we need to decide how to handle. Open for feedback on how to best deal with it.
I can take this one on and fix it. We consolidated on the module naming structure here: TBD54566975/tbdex-rs#31 (comment)
This error resulted from the fact that we had a files that matched their folder's name. E.g: We had crypto/src/key/key.rs. The module's name is `key`, and it contained a module named `key` within it. To fix, I removed all of this inception. `key.rs`'s code now lives in `mod.rs`, same with `key_manager.rs`. Subsequently, this allows us to r emove all of the global use statements like `pub use key::*;`! This also brings consistency with the approach taken in the `tbdex-rs` repo, as discussed here: TBD54566975/tbdex-rs#31 (comment)
Co-authored-by: Adam Mika <88001738+amika-sq@users.noreply.github.com>
andresuribe87
requested review from
KendallWeihe,
mistermoe and
decentralgabe
|
cc @leordev I don't think this impacts your work, but making you aware of the use of |
| @@ -1,8 +1,25 @@ | |||
| mod key; | |||
| pub use key::*; | |||
There was a problem hiding this comment.
Cool, I prefer the explicit syntax for imports
| @@ -39,7 +38,7 @@ mod tests { | |||
| let signature = private_key.sign(payload).unwrap(); | |||
|
|
|||
| let public_key = private_key.to_public(); | |||
| let verification_warnings = public_key.verify(&payload, &signature).unwrap(); | |||
| let verification_warnings = public_key.verify(payload, &signature).unwrap(); | |||
There was a problem hiding this comment.
What provoked this change? Why is signature passed by reference but payload isn't?
There was a problem hiding this comment.
There was a problem hiding this comment.
BTW this was the result of running cargo clippy --fix
There was a problem hiding this comment.
Oh I see, because payload was already initialized by reference whereas signature was not
This PR adds the clippy linter to the repo. See https://doc.rust-lang.org/clippy/index.html for more information.
I applied the automatic fixes. There's still one more error: https://rust-lang.github.io/rust-clippy/master/index.html#/module_inception, which we need to decide how to handle. Open for feedback on how to best deal with it.