ordinals/ord

Use proper error types

Open

#3,192 opened on Feb 28, 2024

View on GitHub
 (10 comments) (0 reactions) (1 assignee)Rust (1,479 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (3,955 stars)
PR merge metrics
 (Avg merge 15d 21h) (5 merged PRs in 30d)

Description

Currently, we use anyhow for all errors. I like anyhow, but it makes it too easy to bubble up an error without context, which leads to a less-than-useful error message. For example, I/O errors don't include the offending file, making them quite inscrutable. We should probably switch to using something like snafu or thiserror.

Contributor guide

Research direction
Examine the current `anyhow` error usage in the codebase, identify common patterns (e.g., I/O errors without file paths), and propose a migration to `thiserror` or `snafu` with proper error types and context.
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.
1-3 hours
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.
75