Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enabled the use of clippy for the project. #144

Merged
merged 1 commit into from
Jun 12, 2023

Conversation

f0rki
Copy link
Contributor

@f0rki f0rki commented Jun 1, 2023

  • Run clippy in CI
    • Require SAFETY documents in front of every unsafe block.
    • Set MSRV version in clippy.toml to avoid lints that break the MSRV
  • Several fixes to make clippy happy
    • Ran cargo clippy --fix
    • Added some clippy exceptions
    • Added many SAFETY comments to unsafe blocks
  • Tested MIRAI static analyzer to find "unintentional panics"
    • added some debug-build overflow checks to satsify MIRAI
    • Currently, installing MIRAI takes way too long in CI so it is
      disabled for now. Need to find a way to cache this (maybe a custom github action or docker container).

* Run clippy in CI
    - Require SAFETY documents in front of every unsafe block.
    - Set MSRV version in clippy.toml to avoid lints that break the MSRV
* Several fixes to make clippy happy
    - Ran cargo clippy --fix
    - Added some clippy exceptions
    - Added many SAFETY comments to unsafe blocks
* Tested MIRAI static analyzer to find "unintentional panics"
    - added some debug-build overflow checks to satsify MIRAI
    - Currently, installing MIRAI takes way too long in CI so it is
      disabled for now. Need to find a way to cache this.

Signed-off-by: Michael Rodler <[email protected]>
@seanmonstar seanmonstar merged commit 6b5d4d9 into seanmonstar:master Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants