yarnpkg / yarnpkg/zpm

Improve error diagnostics

Open
#239 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
225
Forks
19
Avg merge
1d 5h
Merged PRs (30d)
3

Description

Some cli failures currently lack enough context (#234 , #210). This increases debugging time for users.

Proposal

Add missing context + preserve error sources

  • Wrap errors at boundaries with operation/resource context.
  • Ensure file path / URL is included where we already know it.
  • Keep underlying errors as sources.
Open question
  • Is introducing anyhow / miette acceptable ?

cc @arcanis , if this direction makes sense to you, I’m happy to submit PRs.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing issues #234 and #210 and the CLI failure boundaries where context is currently missing; the payload names no files or tests. Clarify whether anyhow or miette is acceptable, then define scoped changes that include known file paths or URLs and preserve underlying errors as sources.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.