JuliaLang/Pkg.jl

Print diff when a tracked branch changes

Open

#274 opened on May 3, 2018

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Julia (296 forks)batch import
display and printingenhancementhelp wanted

Repository metrics

Stars
 (665 stars)
PR merge metrics
 (Avg merge 2d 17h) (6 merged PRs in 30d)

Description

I think it would be useful to print a diff when a tracked branch is updated. Current behaviour:

pkg> add BenchmarkTools#master

# change the master branch

pkg> up
[...]
  Updating `~/.julia/environments/v0.7/Project.toml`
 [6e4b80f9] ~ BenchmarkTools v0.2.5+ #master
  Updating `~/.julia/environments/v0.7/Manifest.toml`
 [6e4b80f9] ~  BenchmarkTools v0.2.5+ #master

which IMO would be better as

pkg> up
[...]
  Updating `~/.julia/environments/v0.7/Project.toml`
 [6e4b80f9] ↑ BenchmarkTools v0.2.5+ #master(commit1) ⇒ v0.2.5+ #master(commit2)
  Updating `~/.julia/environments/v0.7/Manifest.toml`
 [6e4b80f9] ↑ BenchmarkTools v0.2.5+ #master(commit1) ⇒ v0.2.5+ #master(commit2)

Additionally, perhaps we should always print the commit hash for tracked branches, e.g. st would change from

(v0.7) pkg> st
Status `~/.julia/environments/v0.7/Project.toml`
 [6e4b80f9] BenchmarkTools v0.2.5+ #master

to

(v0.7) pkg> st
Status `~/.julia/environments/v0.7/Project.toml`
 [6e4b80f9] BenchmarkTools v0.2.5+ #master(commit)

Contributor guide

Research direction
Find the output formatting functions for `up` and `status` commands in Pkg.jl, and add logic to display commit hash for tracked branches and a diff arrow when a tracked branch changes.
Tech stack
None
Domain
cli
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75