allow for a deprecated table in a Package.toml in a registry

these packages will not tab complete to and will show up as deprecated in pkg status

Fixes #2194

Author: KristofferC

ext/REPLExt/completions.jl

@@ -79,6 +79,7 @@ function complete_remote_package!(comps, partial; hint::Bool)
             name in cmp && continue
             if startswith(regpkg.name, partial)
                 pkg = Registry.registry_info(regpkg)
+                Registry.isdeprecated(pkg) && continue
                 compat_info = Registry.compat_info(pkg)
                 # Filter versions
                 for (v, uncompressed_compat) in compat_info

src/Operations.jl

@@ -50,6 +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
+    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
+        end
+    end
+    return false
+end
+
 function default_preserve()
     return if Base.get_bool_env("JULIA_PKG_PRESERVE_TIERED_INSTALLED", false)
         PRESERVE_TIERED_INSTALLED
@@ -3054,6 +3066,11 @@ function print_status(
             printstyled(io, " [yanked]"; color = :yellow)
         end
 
+        # show if package is deprecated
+        if is_pkg_deprecated(pkg_spec, registries)
+            printstyled(io, " [deprecated]"; color = :yellow)
+        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

src/Registry/registry_instance.jl

@@ -48,6 +48,9 @@ struct PkgInfo
     repo::Union{String, Nothing}
     subdir::Union{String, Nothing}
 
+    # Package.toml [deprecated]:
+    deprecated::Union{Dict{String, Any}, Nothing}
+
     # Versions.toml:
     version_info::Dict{VersionNumber, VersionInfo}
 
@@ -68,6 +71,7 @@ end
 
 isyanked(pkg::PkgInfo, v::VersionNumber) = pkg.version_info[v].yanked
 treehash(pkg::PkgInfo, v::VersionNumber) = pkg.version_info[v].git_tree_sha1
+isdeprecated(pkg::PkgInfo) = pkg.deprecated !== nothing
 
 function uncompress(compressed::Dict{VersionRange, Dict{String, T}}, vsorted::Vector{VersionNumber}) where {T}
     @assert issorted(vsorted)
@@ -201,6 +205,10 @@ function init_package_info!(pkg::PkgEntry)
         repo = get(d_p, "repo", nothing)::Union{Nothing, String}
         subdir = get(d_p, "subdir", nothing)::Union{Nothing, String}
 
+        # The presence of a [deprecated] table indicates the package is deprecated
+        # We store the raw table to allow other tools to use the metadata
+        deprecated = get(d_p, "deprecated", nothing)::Union{Nothing, Dict{String, Any}}
+
         # Versions.toml
         d_v = custom_isfile(pkg.in_memory_registry, pkg.registry_path, joinpath(pkg.path, "Versions.toml")) ?
             parsefile(pkg.in_memory_registry, pkg.registry_path, joinpath(pkg.path, "Versions.toml")) : Dict{String, Any}()
@@ -256,7 +264,7 @@ function init_package_info!(pkg::PkgEntry)
         end
 
         @assert !isdefined(pkg, :info)
-        pkg.info = PkgInfo(repo, subdir, version_info, compat, deps, weak_compat, weak_deps, pkg.info_lock)
+        pkg.info = PkgInfo(repo, subdir, deprecated, version_info, compat, deps, weak_compat, weak_deps, pkg.info_lock)
 
         return pkg.info
     end

test/registry.jl

@@ -41,8 +41,6 @@ function setup_test_registries(dir = pwd())
         )
         write(
             joinpath(regpath, "Example", "Deps.toml"), """
-            ["0.5"]
-            julia = "0.6-1.0"
             """
         )
         write(
@@ -343,6 +341,77 @@ end
         end
     end
 
+    @testset "deprecated package" begin
+        temp_pkg_dir() do depot
+            # Set up test registries with an extra deprecated package
+            regdir = mktempdir()
+            setup_test_registries(regdir)
+
+            # Add a deprecated package to the first registry
+            regpath = joinpath(regdir, "RegistryFoo1")
+            mkpath(joinpath(regpath, "DeprecatedExample"))
+
+            # Add the deprecated package to Registry.toml
+            registry_toml = read(joinpath(regpath, "Registry.toml"), String)
+            registry_toml = replace(
+                registry_toml,
+                "[packages]" =>
+                    "[packages]\n11111111-1111-1111-1111-111111111111 = { name = \"DeprecatedExample\", path = \"DeprecatedExample\" }"
+            )
+            write(joinpath(regpath, "Registry.toml"), registry_toml)
+
+            # Create deprecated package with [deprecated] table
+            write(
+                joinpath(regpath, "DeprecatedExample", "Package.toml"), """
+                name = "DeprecatedExample"
+                uuid = "11111111-1111-1111-1111-111111111111"
+                repo = "https://github.com/test/DeprecatedExample.jl.git"
+
+                [deprecated]
+                reason = "This package is no longer maintained"
+                alternative = "Example"
+                """
+            )
+
+            write(
+                joinpath(regpath, "DeprecatedExample", "Versions.toml"), """
+                ["1.0.0"]
+                git-tree-sha1 = "1234567890abcdef1234567890abcdef12345678"
+                """
+            )
+
+            git_init_and_commit(regpath)
+
+            # Add the test registry
+            Pkg.Registry.add(url = regpath)
+
+            # Test that the package is marked as deprecated
+            registries = Pkg.Registry.reachable_registries()
+            reg_idx = findfirst(r -> r.name == "RegistryFoo", registries)
+            @test reg_idx !== nothing
+
+            reg = registries[reg_idx]
+            pkg_uuid = UUID("11111111-1111-1111-1111-111111111111")
+            @test haskey(reg, pkg_uuid)
+
+            pkg_entry = reg[pkg_uuid]
+            pkg_info = Pkg.Registry.registry_info(pkg_entry)
+
+            # Test that deprecated info is loaded correctly
+            @test Pkg.Registry.isdeprecated(pkg_info)
+            @test pkg_info.deprecated !== nothing
+            @test pkg_info.deprecated["reason"] == "This package is no longer maintained"
+            @test pkg_info.deprecated["alternative"] == "Example"
+
+            # Test that non-deprecated package is not marked as deprecated
+            example1_uuid = UUID("c5f1542f-b8aa-45da-ab42-05303d706c66")
+            example1_entry = reg[example1_uuid]
+            example1_info = Pkg.Registry.registry_info(example1_entry)
+            @test !Pkg.Registry.isdeprecated(example1_info)
+            @test example1_info.deprecated === nothing
+        end
+    end
+
     @testset "yanking" begin
         uuid = Base.UUID("7876af07-990d-54b4-ab0e-23690620f79a") # Example
         # Tests that [email protected] does not get installed