Neptune-Crypto/neptune-core

style: Prefer references to `cli_args::Args`

Open

#532 opened on Mar 27, 2025

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Rust (45 forks)auto 404
choregood first issuelow priority

Repository metrics

Stars
 (110 stars)
PR merge metrics
 (PR metrics pending)

Description

Some test helper setup functions take a reference to cli_args::Args and others take ownership of an object. The latter type generates more boilerplate due to excessive .clone().

The intention behind cli_args::Args is that once set, they never change. (If there is a transgression against this principle anywhere, we need to fix that.) So cloning in order to pass ownership of an object that's not going to change anyway is moot in addition to boilerplatey. Let's prefer references instead.

I do think one exception is necessary. We want one copy of the CLI arguments to live on global state. And we do not want to bother keeping track of lifetimes there. So we clone it once, when constructing global state.

Most of this task boils down to fixing function interfaces in tests and red squiggly lines that result from there.

Contributor guide

Research direction
Identify all test helper functions that take ownership of `cli args::Args` and change their signatures to take a reference. Update all callers to pass a reference instead of cloning.
Tech stack
rust
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70