maplibre/martin

Use indicatif or prodash crates for CLI status reporting

Open

#1,024 opened on Nov 25, 2023

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Rust (377 forks)auto 404
cligood first issuehelp wantedrust

Repository metrics

Stars
 (3,761 stars)
PR merge metrics
 (PR metrics pending)

Description

I think we should switch our output formatting to either indicatif crate or prodash. indicatif supports progress bars and number formatting, so we could probably remove the size_format dependency. prodash seem to support logging better?

We will probably need a single status bar, as we don't have well defined parallelization.

  • martin-cp while generating tiles - this is the most important target
  • mbtiles copy - not certain if this is possible to track the progress of a single SQLite INSERT INTO ... sql statement.

Indicatif Demo

demo

Prodash Demo

asciicast

Contributor guide

Research direction
Evaluate the indicatif and prodash crates for CLI progress reporting. Check how the current output formatting works, then implement a status bar for tile generation in martin cp.
Tech stack
rust
Domain
backendcli
Issue type
Feature
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.
Fresh
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