code quality (linting and formatting)

[danieleades]

It doesn't appear that linting or formatting are applied/checked in this repo. Would you be interested in pull requests for these?

I can split these into separate issues if you like. I think the value of auto-formatting is well documented, particularly for open-source projects.

clippy also is useful for catching both correctness and style issues. The following PRs are mostly fixes for various clippy lints

see:

• remove unnecessary casts #304
• use auto-formatting #305
• remove casting from ptr offset #306
• remove redundant field names #307
• remove needless borrows #308
• don't pass mut references unless you need to #309
• prefer 'is_empty' to zero length comparison #310
• shrink absurd range comparisons #311
• prefer 'assert' to 'assert_eq' for bools #312
• remove explicit lifetimes where they can be elided #313
• remove operations that don't do anything #315
• remove needless pass by value #317
• remove manual implementation of 'AddAssign' #318
• remove redundant 'extern crate' calls #319
• remove useless conversions #320
• use lossless conversions where available #321
• remove some needless cloning #322
• refactor 'Word' struct #325
• Clippy/new without default #331

note that some of these may need to be rebased after others are merged (if they are merged, of course).

#305 in particular has potential to be a little hairy. that should probably go last, and also has the potential to cause headaches for other open PRs. My advice, rip the bandaid off. It'll save a lot of headaches in future.

[danieleades]

you can probably guess from the PRs that i'm gearing up to adding a linting job to CI, but first I need to make sure said job would actually pass

[dwrensha]

Autoformatting sounds good to me. I'm a bit more skeptical about Clippy, as it seems to make bad suggestions sometimes (e.g. https://github.com/capnproto/capnproto-rust/pull/312/files#r1020222229 ). I suppose we could add specific suppressions when we disagree with Clippy?

[danieleades]

suppose we could add specific suppressions when we disagree with Clippy?

exactly! better to opt out of specific lints than not have any linting, i think. I'll close the PR you reference, and when I open a PR to add automatic linting i'll suppress those warnings.

[danieleades]

getting very close now. Just a handful more lint errors and warnings to address and then linting can be added to CI

[dwrensha]

Closing, because all of the checkmarks are filled in. Thanks!