show more deprecated info in status

Author: KristofferC

docs/src/registries.md

@@ -114,7 +114,11 @@ One use of the `[metadata]` table is to mark packages as deprecated using `[meta
 - Be excluded from tab-completion suggestions
 - Still be installable and usable
 
-The `[metadata.deprecated]` table can contain arbitrary metadata fields. Common fields include:
+The `[metadata.deprecated]` table can contain arbitrary metadata fields. Two special fields are recognized by Pkg and displayed when using `pkg> status --deprecated`:
+- `reason`: A string explaining why the package is deprecated
+- `alternative`: A string suggesting a replacement package
+
+Example:
 
 ```toml
 name = "MyPackage"
@@ -126,7 +130,7 @@ reason = "This package is no longer maintained"
 alternative = "ReplacementPackage"
 ```
 
-The specific fields within `[metadata.deprecated]` are not currently used by Pkg itself, but are stored to allow other tools and registries to utilize this metadata.
+Other fields can be added to `[metadata.deprecated]` for use by registries or other tools.
 
 ### Registry Compat.toml
 

src/API.jl

@@ -1314,14 +1314,15 @@ end
 
 @deprecate status(mode::PackageMode) status(mode = mode)
 
-function status(ctx::Context, pkgs::Vector{PackageSpec}; diff::Bool = false, mode = PKGMODE_PROJECT, workspace::Bool = false, outdated::Bool = false, compat::Bool = false, extensions::Bool = false, io::IO = stdout_f())
+function status(ctx::Context, pkgs::Vector{PackageSpec}; diff::Bool = false, mode = PKGMODE_PROJECT, workspace::Bool = false, outdated::Bool = false, deprecated::Bool = false, compat::Bool = false, extensions::Bool = false, io::IO = stdout_f())
     if compat
         diff && pkgerror("Compat status has no `diff` mode")
         outdated && pkgerror("Compat status has no `outdated` mode")
+        deprecated && pkgerror("Compat status has no `deprecated` mode")
         extensions && pkgerror("Compat status has no `extensions` mode")
         Operations.print_compat(ctx, pkgs; io)
     else
-        Operations.status(ctx.env, ctx.registries, pkgs; mode, git_diff = diff, io, outdated, extensions, workspace)
+        Operations.status(ctx.env, ctx.registries, pkgs; mode, git_diff = diff, io, outdated, deprecated, extensions, workspace)
     end
     return nothing
 end

src/Operations.jl

@@ -50,16 +50,18 @@ function is_pkgversion_yanked(entry::PackageEntry, registries::Vector{Registry.R
     return is_pkgversion_yanked(entry.uuid, entry.version, registries)
 end
 
-function is_pkg_deprecated(pkg::Union{PackageSpec, PackageEntry}, registries::Vector{Registry.RegistryInstance} = Registry.reachable_registries())
-    pkg.uuid === nothing && return false
+function get_pkg_deprecation_info(pkg::Union{PackageSpec, PackageEntry}, registries::Vector{Registry.RegistryInstance} = Registry.reachable_registries())
+    pkg.uuid === nothing && return nothing
     for reg in registries
         reg_pkg = get(reg, pkg.uuid, nothing)
         if reg_pkg !== nothing
             info = Registry.registry_info(reg_pkg)
-            Registry.isdeprecated(info) && return true
+            if Registry.isdeprecated(info)
+                return info.deprecated
+            end
         end
     end
-    return false
+    return nothing
 end
 
 function default_preserve()
@@ -2927,11 +2929,12 @@ struct PackageStatusData
     compat_data::Union{Nothing, Tuple{Vector{String}, VersionNumber, VersionNumber}}
     changed::Bool
     extinfo::Union{Nothing, Vector{ExtInfo}}
+    deprecation_info::Union{Nothing, Dict{String, Any}}
 end
 
 function print_status(
         env::EnvCache, old_env::Union{Nothing, EnvCache}, registries::Vector{Registry.RegistryInstance}, header::Symbol,
-        uuids::Vector, names::Vector; manifest = true, diff = false, ignore_indent::Bool, workspace::Bool, outdated::Bool, extensions::Bool, io::IO,
+        uuids::Vector, names::Vector; manifest = true, diff = false, ignore_indent::Bool, workspace::Bool, outdated::Bool, deprecated::Bool, extensions::Bool, io::IO,
         mode::PackageMode, hidden_upgrades_info::Bool, show_usagetips::Bool = true
     )
     not_installed_indicator = sprint((io, args) -> printstyled(io, args...; color = Base.error_color()), "→", context = io)
@@ -3015,6 +3018,19 @@ function print_status(
             continue
         end
 
+        # Deprecated info
+        deprecation_info = nothing
+        pkg_deprecated = false
+        if !isnothing(new)
+            pkg_spec = something(new, old)
+            deprecation_info = get_pkg_deprecation_info(pkg_spec, registries)
+            pkg_deprecated = deprecation_info !== nothing
+        end
+
+        # if we are running with deprecated, only show packages that are deprecated
+        if deprecated && !pkg_deprecated
+            continue
+        end
 
         # TODO: Show extension deps for project as well?
 
@@ -3033,7 +3049,7 @@ function print_status(
         no_visible_packages_heldback &= (!changed || !pkg_heldback)
         no_packages_heldback &= !pkg_heldback
 
-        push!(package_statuses, PackageStatusData(uuid, old, new, pkg_downloaded, pkg_upgradable, pkg_heldback, cinfo, changed, ext_info))
+        push!(package_statuses, PackageStatusData(uuid, old, new, pkg_downloaded, pkg_upgradable, pkg_heldback, cinfo, changed, ext_info, deprecation_info))
     end
 
     for pkg in package_statuses
@@ -3067,10 +3083,22 @@ function print_status(
         end
 
         # show if package is deprecated
-        if is_pkg_deprecated(pkg_spec, registries)
+        if pkg.deprecation_info !== nothing
             printstyled(io, " [deprecated]"; color = :yellow)
         end
 
+        # show deprecation details when using --deprecated flag
+        if deprecated && !diff && pkg.deprecation_info !== nothing
+            reason = get(pkg.deprecation_info, "reason", nothing)
+            alternative = get(pkg.deprecation_info, "alternative", nothing)
+            if reason !== nothing
+                printstyled(io, " (reason: ", reason, ")"; color = :yellow)
+            end
+            if alternative !== nothing
+                printstyled(io, " (alternative: ", alternative, ")"; color = :yellow)
+            end
+        end
+
         if outdated && !diff && pkg.compat_data !== nothing
             packages_holding_back, max_version, max_version_compat = pkg.compat_data
             if pkg.new.version !== max_version_compat && max_version_compat != max_version
@@ -3161,6 +3189,17 @@ function print_status(
         It is recommended to update them to resolve a valid version.""", color = Base.warn_color(), ignore_indent)
     end
 
+    # Check if any packages are deprecated for info message
+    any_deprecated_packages = any(pkg -> pkg.deprecation_info !== nothing, package_statuses)
+
+    # Add info for deprecated packages (only if not already in deprecated mode)
+    if !deprecated && any_deprecated_packages
+        deprecated_str = sprint((io, args) -> printstyled(io, args...; color = :yellow), "[deprecated]", context = io)
+        tipend = manifest ? " -m" : ""
+        tip = show_usagetips ? " Use `status --deprecated$tipend` to see more information." : ""
+        printpkgstyle(io, :Info, """Packages marked with $deprecated_str are no longer maintained.$tip""", color = Base.info_color(), ignore_indent)
+    end
+
     return nothing
 end
 
@@ -3192,7 +3231,7 @@ end
 function status(
         env::EnvCache, registries::Vector{Registry.RegistryInstance}, pkgs::Vector{PackageSpec} = PackageSpec[];
         header = nothing, mode::PackageMode = PKGMODE_PROJECT, git_diff::Bool = false, env_diff = nothing, ignore_indent = true,
-        io::IO, workspace::Bool = false, outdated::Bool = false, extensions::Bool = false, hidden_upgrades_info::Bool = false, show_usagetips::Bool = true
+        io::IO, workspace::Bool = false, outdated::Bool = false, deprecated::Bool = false, extensions::Bool = false, hidden_upgrades_info::Bool = false, show_usagetips::Bool = true
     )
     io == Base.devnull && return
     # if a package, print header
@@ -3223,10 +3262,10 @@ function status(
     diff = old_env !== nothing
     header = something(header, diff ? :Diff : :Status)
     if mode == PKGMODE_PROJECT || mode == PKGMODE_COMBINED
-        print_status(env, old_env, registries, header, filter_uuids, filter_names; manifest = false, diff, ignore_indent, io, workspace, outdated, extensions, mode, hidden_upgrades_info, show_usagetips)
+        print_status(env, old_env, registries, header, filter_uuids, filter_names; manifest = false, diff, ignore_indent, io, workspace, outdated, deprecated, extensions, mode, hidden_upgrades_info, show_usagetips)
     end
     if mode == PKGMODE_MANIFEST || mode == PKGMODE_COMBINED
-        print_status(env, old_env, registries, header, filter_uuids, filter_names; diff, ignore_indent, io, workspace, outdated, extensions, mode, hidden_upgrades_info, show_usagetips)
+        print_status(env, old_env, registries, header, filter_uuids, filter_names; diff, ignore_indent, io, workspace, outdated, deprecated, extensions, mode, hidden_upgrades_info, show_usagetips)
     end
     return if is_manifest_current(env) === false
         tip = if show_usagetips

src/REPLMode/command_declarations.jl

@@ -435,16 +435,17 @@ compound_declarations = [
                 PSA[:name => "manifest", :short_name => "m", :api => :mode => PKGMODE_MANIFEST],
                 PSA[:name => "diff", :short_name => "d", :api => :diff => true],
                 PSA[:name => "outdated", :short_name => "o", :api => :outdated => true],
+                PSA[:name => "deprecated", :api => :deprecated => true],
                 PSA[:name => "compat", :short_name => "c", :api => :compat => true],
                 PSA[:name => "extensions", :short_name => "e", :api => :extensions => true],
                 PSA[:name => "workspace", :api => :workspace => true],
             ],
             :completions => :complete_installed_packages,
             :description => "summarize contents of and changes to environment",
             :help => md"""
-                    [st|status] [-d|--diff] [--workspace] [-o|--outdated] [pkgs...]
-                    [st|status] [-d|--diff] [--workspace] [-o|--outdated] [-p|--project] [pkgs...]
-                    [st|status] [-d|--diff] [--workspace] [-o|--outdated] [-m|--manifest] [pkgs...]
+                    [st|status] [-d|--diff] [--workspace] [-o|--outdated] [--deprecated] [pkgs...]
+                    [st|status] [-d|--diff] [--workspace] [-o|--outdated] [--deprecated] [-p|--project] [pkgs...]
+                    [st|status] [-d|--diff] [--workspace] [-o|--outdated] [--deprecated] [-m|--manifest] [pkgs...]
                     [st|status] [-d|--diff] [--workspace] [-e|--extensions] [-p|--project] [pkgs...]
                     [st|status] [-d|--diff] [--workspace] [-e|--extensions] [-m|--manifest] [pkgs...]
                     [st|status] [-c|--compat] [pkgs...]
@@ -455,7 +456,10 @@ compound_declarations = [
                 constraints. To see why use `pkg> status --outdated` which shows any packages
                 that are not at their latest version and if any packages are holding them back.
                 Packages marked with `[yanked]` have been yanked from the registry and should be
-                updated or removed.
+                updated or removed. Packages marked with `[deprecated]` are no longer maintained.
+
+                Use `pkg> status --deprecated` to show only deprecated packages along with deprecation
+                information such as the reason and alternative packages (if provided by the registry).
 
                 Use `pkg> status --extensions` to show dependencies with extensions and what extension dependencies
                 of those that are currently loaded.

test/registry.jl

@@ -409,6 +409,19 @@ end
             example1_info = Pkg.Registry.registry_info(example1_entry)
             @test !Pkg.Registry.isdeprecated(example1_info)
             @test example1_info.deprecated === nothing
+
+            # Test get_pkg_deprecation_info function
+            using Pkg.Operations: get_pkg_deprecation_info
+            deprecated_pkg_spec = Pkg.Types.PackageSpec(name = "DeprecatedExample", uuid = pkg_uuid)
+            normal_pkg_spec = Pkg.Types.PackageSpec(name = "Example1", uuid = example1_uuid)
+
+            dep_info = get_pkg_deprecation_info(deprecated_pkg_spec, registries)
+            @test dep_info !== nothing
+            @test dep_info["reason"] == "This package is no longer maintained"
+            @test dep_info["alternative"] == "Example"
+
+            normal_info = get_pkg_deprecation_info(normal_pkg_spec, registries)
+            @test normal_info === nothing
         end
     end