status: add icons to indicate package updatability #2906

IanButterworth · 2021-12-31T02:38:09Z

Adds two icons to the status report:

⌃ for packages where a newer version can be installed
⌅ for packages where a newer version exists, but cannot be installed

~~Also adds padding to align the version numbers to make things a bit tidier?~~

If the user wants more information they can use pkg> status --outdated

I don't see a significant increase in execution time
master: 0.004629 seconds (8.33 k allocations: 722.516 KiB)
this PR: 0.006784 seconds (8.40 k allocations: 771.539 KiB)

Related issues
#1655
#2682

Todo

Needs tests adjusted for new padding etc.
Needs docs
Needs news

Edit:

KristofferC · 2021-12-31T06:46:33Z

I think this is an appropriate level of noise to make. Originally I thought of mimicking the icon for the "not downloaded warning" but maybe having it close to the versions, as done here, makes more sense. I wonder if having a short hint towards status - -outdated at the bottom when one of these are printed is a good idea. That's also similar to the not downloaded warning telling you to do an instantiate.

DilumAluthge · 2021-12-31T16:01:17Z

I wonder if having a short hint towards status - -outdated at the bottom when one of these are printed is a good idea.

I think this would be a good addition!

IanButterworth · 2021-12-31T16:51:54Z

Added!
I think ⌃ is obvious enough so doesn't need a hint?

(@v1.8) pkg> st
Status `~/.julia/environments/v1.8/Project.toml`
  [336ed68f] CSV    v0.8.5 ⌅
  [295af30f] Revise v3.3.1
  [8dfed614] Test  
Info packages marked with ⌅ have new versions available that cannot be installed. To see why use `status --outdated`

DilumAluthge · 2021-12-31T19:28:14Z

I think ⌃ is obvious enough so doesn't need a hint?

I was thinking we would have a hint for either symbol.

IanButterworth · 2021-12-31T22:54:56Z

Ok. How about this

(@v1.8) pkg> st
Status `~/.julia/environments/v1.8/Project.toml`
  [336ed68f] CSV    v0.8.5 ⌃
  [295af30f] Revise v3.3.1
  [8dfed614] Test  
Info packages marked with ⌃ have new versions available

(@v1.8) pkg> st
Status `~/.julia/environments/v1.8/Project.toml`
  [336ed68f] CSV    v0.8.5 ⌅
  [295af30f] Revise v3.3.1
  [8dfed614] Test  
Info packages marked with ⌅ have new versions available but cannot be upgraded. To see why use `status --outdated`

(@v1.8) pkg> st
Status `~/.julia/environments/v1.8/Project.toml`
  [336ed68f] CSV    v0.8.5 ⌅
  [295af30f] Revise v3.3.0 ⌃
  [8dfed614] Test  
Info packages marked with ⌃ and ⌅ have new versions available, but those with ⌅ cannot be upgraded. To see why use `status --outdated`

DilumAluthge · 2021-12-31T22:56:17Z

I like it!

DilumAluthge · 2021-12-31T22:57:11Z

Missing a colon after Info?

IanButterworth · 2021-12-31T22:58:56Z

Info is colored green, like printpkgstyle

IanButterworth · 2022-01-01T00:56:51Z

Is the last commit one reformat too far? It aligns the info past the version

     Status `/tmp/jl_BTeMGp/Project.toml`
  [54cfe95a] Pkg           v1.8.0    `~/work/Pkg.jl/Pkg.jl`
  [56f22d72] Artifacts               `@stdlib/Artifacts`
  [ade2ca70] Dates                   `@stdlib/Dates`
  [f43a241f] Downloads     v1.6.0    `@stdlib/Downloads`
  [76f85450] LibGit2                 `@stdlib/LibGit2`
  [8f399da3] Libdl                   `@stdlib/Libdl`
  [56ddb016] Logging                 `@stdlib/Logging`
  [d6f4376e] Markdown                `@stdlib/Markdown`
  [de0858da] Printf                  `@stdlib/Printf`
  [3fa0cd96] REPL                    `@stdlib/REPL`
  [9a3f8284] Random                  `@stdlib/Random`
  [ea8e919c] SHA           v0.7.0    `@stdlib/SHA`
  [9e88b42a] Serialization           `@stdlib/Serialization`
  [fa267f1f] TOML          v1.0.0    `@stdlib/TOML`
  [a4e569a6] Tar           v1.10.0   `@stdlib/Tar`
  [8dfed614] Test                    `@stdlib/Test`
  [cf7118a7] UUIDs                   `@stdlib/UUIDs`
  [3f19e933] p7zip_jll     v16.2.1+1 `@stdlib/p7zip_jll`
      Status `/tmp/jl_BTeMGp/Manifest.toml`
  [54cfe95a] Pkg                v1.8.0     `~/work/Pkg.jl/Pkg.jl`
  [0dad84c5] ArgTools           v1.1.1     `@stdlib/ArgTools`
  [56f22d72] Artifacts                     `@stdlib/Artifacts`
  [2a0f44e3] Base64                        `@stdlib/Base64`
  [ade2ca70] Dates                         `@stdlib/Dates`
  [f43a241f] Downloads          v1.6.0     `@stdlib/Downloads`
  [7b1f6079] FileWatching                  `@stdlib/FileWatching`
  [b77e0a4c] InteractiveUtils              `@stdlib/InteractiveUtils`
  [b27032c2] LibCURL            v0.6.3     `@stdlib/LibCURL`
  [76f85450] LibGit2                       `@stdlib/LibGit2`
  [8f399da3] Libdl                         `@stdlib/Libdl`
  [56ddb016] Logging                       `@stdlib/Logging`
  [d6f4376e] Markdown                      `@stdlib/Markdown`
  [ca575930] NetworkOptions     v1.2.0     `@stdlib/NetworkOptions`
  [de0858da] Printf                        `@stdlib/Printf`
  [3fa0cd96] REPL                          `@stdlib/REPL`
  [9a3f8284] Random                        `@stdlib/Random`
  [ea8e919c] SHA                v0.7.0     `@stdlib/SHA`
  [9e88b42a] Serialization                 `@stdlib/Serialization`
  [6462fe0b] Sockets                       `@stdlib/Sockets`
  [fa267f1f] TOML               v1.0.0     `@stdlib/TOML`
  [a4e569a6] Tar                v1.10.0    `@stdlib/Tar`
  [8dfed614] Test                          `@stdlib/Test`
  [cf7118a7] UUIDs                         `@stdlib/UUIDs`
  [4ec0a83e] Unicode                       `@stdlib/Unicode`
  [deac9b47] LibCURL_jll        v7.73.0+4  `@stdlib/LibCURL_jll`
  [29816b5a] LibSSH2_jll        v1.9.1+2   `@stdlib/LibSSH2_jll`
  [c8ffd9c3] MbedTLS_jll        v2.24.0+2  `@stdlib/MbedTLS_jll`
  [14a3606d] MozillaCACerts_jll v2020.7.22 `@stdlib/MozillaCACerts_jll`
  [83775a58] Zlib_jll           v1.2.12+1  `@stdlib/Zlib_jll`
  [8e850ede] nghttp2_jll        v1.41.0+1  `@stdlib/nghttp2_jll`
  [3f19e933] p7zip_jll          v16.2.1+1  `@stdlib/p7zip_jll`

IanButterworth · 2022-01-01T21:49:48Z

I'm happy with this now.

I think the new formatting of the status output into columns helps with readability, but it is a little tangential.. I just felt it was needed because the new indicators made it a little harder to read without column formatting

KristofferC · 2022-01-02T19:36:04Z

Can't say I am an immediate fan of the aligning but it might be one of those things that take get used to.

When I thought about a feature like this, I was thinking of putting the icon in the left gutter (which we already use to show the icon when a package is not downloaded).

IanButterworth · 2022-01-02T19:38:21Z

yeah, that's definitely viable. Without the tips I thought it needed to be beside the version number to make it clearer, but with the tips I think the gutter is a good place for it, like the not downloaded icon & tip.

I'll undo the reformatting

IanButterworth · 2022-01-02T22:30:16Z

Perhaps similarly to #2866 in the diff mode when there are no changes we could also list packages that are held back?

(@v1.8) pkg> st
Status `~/.julia/environments/v1.8/Project.toml`
  [336ed68f] CSV v0.9.11
  [c46f51b8] ProfileView v1.0.1
⌅ [295af30f] Revise v3.3.0
  [77ec8976] GTK3_jll v3.24.31+0 `~/.julia/dev/GTK3_jll`
Info packages marked with ⌅ have new versions available but cannot be upgraded. To see why use `status --outdated`

(@v1.8) pkg> up
    Updating registry at `~/.julia/registries/General.toml`
  No Changes to `~/.julia/environments/v1.8/Project.toml`
⌅ [295af30f] Revise v3.3.0
  No Changes to `~/.julia/environments/v1.8/Manifest.toml`
⌅ [295af30f] Revise v3.3.0
Info packages marked with ⌅ have new versions available but cannot be upgraded. To see why use `status --outdated`

currently you'd just get

(@v1.8) pkg> up
    Updating registry at `~/.julia/registries/General.toml`
  No Changes to `~/.julia/environments/v1.8/Project.toml`
  No Changes to `~/.julia/environments/v1.8/Manifest.toml

DilumAluthge · 2022-01-02T22:31:18Z

Seems reasonable to me.

DilumAluthge · 2022-01-02T22:33:19Z

Although, would that make the view for ] up too noisy? Will users expect that ] up only prints the packages that are modified?

IanButterworth · 2022-01-02T22:49:41Z

Perhaps just

(@v1.8) pkg> up
    Updating registry at `~/.julia/registries/General.toml`
  No Changes to `~/.julia/environments/v1.8/Project.toml`
  No Changes to `~/.julia/environments/v1.8/Manifest.toml
Info some packages have new versions available but are held back. Use `status --outdated` for more information.

DilumAluthge · 2022-01-02T22:50:21Z

Nice!

DilumAluthge · 2022-01-02T22:52:49Z

Presumably it's possible to get a situation where, after you do ] up, there are some packages that would have the ⌃ symbol, right?

E.g. if there are two optima, and the resolver has to pick one.

In that case, there would be "some packages that have new versions available", except that they aren't being held back, right? Presumably we should still print some kind of message in that case?

DilumAluthge · 2022-01-02T22:53:52Z

Maybe: "some packages have new versions available, but it is not possible to update to those new versions without downgrading some other packages".

IanButterworth · 2022-01-02T23:05:31Z

I think that's rare and Info some packages have new versions available but are held back. is accurate-enough for a generic message

IanButterworth · 2022-01-03T01:36:58Z

Added to up only. A no-change diff in any other status print won't show this info message

(@v1.8) pkg> up
    Updating registry at `~/.julia/registries/General.toml`
  No Changes to `~/.julia/environments/v1.8/Project.toml`
  No Changes to `~/.julia/environments/v1.8/Manifest.toml`
        Info Some packages have new versions but cannot be upgraded. To see why use `status --outdated`

KristofferC · 2022-01-03T13:52:08Z

(@v1.7) pkg> st
Status `~/.julia/environments/v1.7/Project.toml`
⌃ [6e4b80f9] BenchmarkTools v1.1.0
→  [f68482b8] Cthulhu v2.4.4
  [31a5f54b] Debugger v0.7.0
...
Info Packages marked with → are not downloaded, use `instantiate` to download
Info Packages marked with ⌃ have new versions available

looks a bit misaligned.

Should the ⌅ have some color?

IanButterworth · 2022-01-03T13:59:57Z

Should the ⌅ have some color?

Maybe the info color? I didn't think it warranted green or warning or error colors.

I'll look into that alignment bug

IanButterworth · 2022-01-03T15:18:21Z

KristofferC · 2022-01-03T20:00:00Z

The --outdated looks like

so fram that, using yellow seems like it would match, or?

IanButterworth · 2022-01-03T20:12:19Z

Actually both upgradable and heldback lines in the --outdated report are yellow.. so yellow might not make sense?

But, I think the right answer might emerge after using it? We could go with yellow and see?

KristofferC

Let's try with this iteration for now. Always possible to tweak based on feedback. Great job!

DilumAluthge · 2022-01-03T20:24:11Z

Thank you Ian!

IanButterworth force-pushed the ib/status_updatable_icons branch from 486551d to 7350b8c Compare December 31, 2021 02:48

IanButterworth added 4 commits December 31, 2021 16:49

add updatable icons to status prints

f527a96

fix name length calc

68d3873

add ⌅ hint

ef83be5

exclude repo- and path-tracking packages

6669d17

IanButterworth force-pushed the ib/status_updatable_icons branch 2 times, most recently from 29b9a33 to 9c7b37e Compare December 31, 2021 23:57

IanButterworth added 3 commits January 1, 2022 14:08

adjust status print test patterns

bee56b1

add ⌃ hint

099f097

also align cols beyond version

e440b8e

IanButterworth force-pushed the ib/status_updatable_icons branch from 774d091 to e440b8e Compare January 1, 2022 19:09

IanButterworth added 3 commits January 1, 2022 15:01

add to docs and changelog

74a2bc5

Merge branch 'master' into ib/status_updatable_icons

2a1c722

more formatting & padding fixes

dd79a76

IanButterworth force-pushed the ib/status_updatable_icons branch from 9f53af5 to dd79a76 Compare January 1, 2022 20:58

IanButterworth changed the title ~~add icons to indicate updatability to status prints~~ status: add icons to indicate package updatability and format into columns Jan 1, 2022

IanButterworth added 2 commits January 2, 2022 15:46

move indicators to start, remove column formatting

102b87b

grammar fix

e2bf52f

IanButterworth added this to the 1.8 milestone Jan 2, 2022

more fix

3d857c0

IanButterworth requested a review from KristofferC January 2, 2022 22:22

add info message to no-change diff too

b8b1d45

also add heldback info to no-change upgrade

e697c9e

IanButterworth force-pushed the ib/status_updatable_icons branch from acddebe to e697c9e Compare January 3, 2022 02:22

IanButterworth mentioned this pull request Jan 3, 2022

Warn if non-latest version is installed after explicit up #2866

Closed

fix indenting, color formatting, show logic

47d4d25

minor fix

953f936

make heldback yellow

d398524

KristofferC approved these changes Jan 3, 2022

View reviewed changes

revert docstring formatting and add new indicators

06355d0

IanButterworth merged commit 69a95ac into JuliaLang:master Jan 3, 2022

IanButterworth deleted the ib/status_updatable_icons branch January 3, 2022 21:44

KristofferC mentioned this pull request Feb 5, 2022

Show package version and whether it's the latest after ] add command #2682

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

status: add icons to indicate package updatability #2906

status: add icons to indicate package updatability #2906

IanButterworth commented Dec 31, 2021 •

edited

Loading

KristofferC commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

IanButterworth commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

IanButterworth commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

IanButterworth commented Dec 31, 2021

IanButterworth commented Jan 1, 2022

IanButterworth commented Jan 1, 2022 •

edited

Loading

KristofferC commented Jan 2, 2022

IanButterworth commented Jan 2, 2022 •

edited

Loading

IanButterworth commented Jan 2, 2022 •

edited

Loading

DilumAluthge commented Jan 2, 2022 •

edited

Loading

DilumAluthge commented Jan 2, 2022

IanButterworth commented Jan 2, 2022

DilumAluthge commented Jan 2, 2022

DilumAluthge commented Jan 2, 2022 •

edited

Loading

DilumAluthge commented Jan 2, 2022

IanButterworth commented Jan 2, 2022

IanButterworth commented Jan 3, 2022

KristofferC commented Jan 3, 2022 •

edited

Loading

IanButterworth commented Jan 3, 2022

IanButterworth commented Jan 3, 2022 •

edited

Loading

KristofferC commented Jan 3, 2022

IanButterworth commented Jan 3, 2022

KristofferC left a comment

DilumAluthge commented Jan 3, 2022

status: add icons to indicate package updatability #2906

status: add icons to indicate package updatability #2906

Conversation

IanButterworth commented Dec 31, 2021 • edited Loading

KristofferC commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

IanButterworth commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

IanButterworth commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

DilumAluthge commented Dec 31, 2021

IanButterworth commented Dec 31, 2021

IanButterworth commented Jan 1, 2022

IanButterworth commented Jan 1, 2022 • edited Loading

KristofferC commented Jan 2, 2022

IanButterworth commented Jan 2, 2022 • edited Loading

IanButterworth commented Jan 2, 2022 • edited Loading

DilumAluthge commented Jan 2, 2022 • edited Loading

DilumAluthge commented Jan 2, 2022

IanButterworth commented Jan 2, 2022

DilumAluthge commented Jan 2, 2022

DilumAluthge commented Jan 2, 2022 • edited Loading

DilumAluthge commented Jan 2, 2022

IanButterworth commented Jan 2, 2022

IanButterworth commented Jan 3, 2022

KristofferC commented Jan 3, 2022 • edited Loading

IanButterworth commented Jan 3, 2022

IanButterworth commented Jan 3, 2022 • edited Loading

KristofferC commented Jan 3, 2022

IanButterworth commented Jan 3, 2022

KristofferC left a comment

Choose a reason for hiding this comment

DilumAluthge commented Jan 3, 2022

IanButterworth commented Dec 31, 2021 •

edited

Loading

IanButterworth commented Jan 1, 2022 •

edited

Loading

IanButterworth commented Jan 2, 2022 •

edited

Loading

IanButterworth commented Jan 2, 2022 •

edited

Loading

DilumAluthge commented Jan 2, 2022 •

edited

Loading

DilumAluthge commented Jan 2, 2022 •

edited

Loading

KristofferC commented Jan 3, 2022 •

edited

Loading

IanButterworth commented Jan 3, 2022 •

edited

Loading