haskell/hie-bios

Progress reporting

Open

#405 opened on Jun 10, 2023

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Haskell (70 forks)auto 404
ZuriHacgood first issue

Repository metrics

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

Description

At the moment we don't give good feedback to the user when the build tool is building stuff. Ideally, we would show something like "Building dependencies 54/500" or something via progress reporting.

However this is pretty hard to do well since we just shell out to the build tool and don't have a proper interface. Nonetheless, a hacky implementation in terms of parsing the stdout or something would be really nice for users and so I think it's probably worth it.

We'd need two things:

  1. An interface for progress reporting for cradles
  2. An implementation of some kind of progress reporting for, say, cabal

Contributor guide

Research direction
Investigate how cradles are defined and how build tool output is currently captured; design a progress reporting interface and implement a basic parser for cabal's stdout output.
Tech stack
haskell
Domain
developer experiencebuild system
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.
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.
Mostly clear
Prerequisites
GitHaskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65