Skip to content

Server crate-wide lint suppressions hide maintainability and protocol-safety signals #163

Description

@Bnjoroge1

Severity

P3 / maintainability

Review baseline

0bd0e314696e520aa47620cbe8f008d010e01e57

Summary

The runner server crate begins with broad crate-wide suppressions including missing_docs, dead_code, and clippy::too_many_arguments.

For a protocol-heavy, security-sensitive service, these suppressions hide useful signals when new endpoints, state fields, or oversized interfaces are added. They also make it harder to distinguish deliberate compatibility scaffolding from dead or unreachable code.

Recommended remediation

  • Remove crate-wide dead_code and clippy::too_many_arguments allowances.
  • Apply narrow #[allow(...)] annotations only where compatibility code genuinely requires them, with a short rationale.
  • Consider keeping missing_docs relaxed for private implementation code if necessary, but require documentation on public/protocol boundary types.
  • Run clippy with warnings denied for newly introduced code in CI.

Acceptance criteria

  • New dead code produces a CI warning/error unless explicitly annotated.
  • Oversized function interfaces require a local justification or refactor.
  • Protocol boundary/public types are documented sufficiently to make identity and lifecycle expectations clear.
  • Existing intentional compatibility shims retain narrowly scoped suppressions rather than a crate-wide exemption.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions