google/comprehensive-rust

Make it easy to react to `dprint fmt` errors

Open

#1,163 opened on Sep 4, 2023

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Rust (32,954 stars) (2,009 forks)batch import
enhancementgood first issuehelp wanted

Description

We should fix https://github.com/dprint/check/issues/11, which is about making it easy to react to dprint fmt errors.

In short, we should ensure that the errors show up in GitHub on the relevant line in code reviews. Ideally, this should be in the form of a GitHub suggestion.

Contributor guide

Tech stack
rust
Domain
developer experiencetoolingci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
Basic knowledge of RustFamiliarity with GitHub ActionsUnderstanding of dprint tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue aims to display dprint fmt errors as GitHub suggestions on the relevant lines in code reviews. It references dprint/check#11 for context. To implement, one should investigate GitHub's suggestion API and how to format error output to be accepted as suggestions. The repository is a Rust course, so the solution likely involves modifying existing GitHub Actions workflows or adding a new one.