Azure / Azure/azure-sdk-for-rust

Run custom lints during PR/CI

Open
#3,404 0 comments 0 reactions 0 assignees View on GitHub
EngSys test-enhancement
Dominant language
Rust
Stars
884
Forks
365
Avg merge
2d 19h
Merged PRs (30d)
109

Description

Using [dylint](https://github.com/trailofbits/dylint) or similar, we need to write some lints to help catch issues against guidelines early when the dev is most likely to do something about it.

It'd be nice to run them during the inner loop, but rust-analyzer only supports a single linter (we configure this to be clippy, which is better than the default `cargo check`) and I'd rather run that then our few (by comparison) lints. There is a way to have custom lints run clippy, but there's a maintenance burden of keeping the verison in check with the toolchain, which means we'd also have to dictate a particular toolchain version that makes our existing PR/CI process more difficult (have to override each command or at least each job via `rustup`).

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the repository's existing PR/CI jobs and the proposed dylint approach, including how clippy and the Rust toolchain are currently configured. Done means the custom lints run during PR/CI without requiring a burdensome fixed toolchain version or disrupting the existing workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.