display the availability badges or deprecation notice

Author: tayloraswift

Assets/css/Main.css

@@ -1,6 +1,6 @@
 <div align="center">
 
-<strong><em><code>unidoc</code></em></strong><br><small><code>0.1.0</code></small>
+<strong><em><code>unidoc</code></em></strong><br><small><code>0.1.3</code></small>
 
 [![ci build status](https://github.com/kelvin13/swift-unidoc/actions/workflows/build.yml/badge.svg)](https://github.com/kelvin13/swift-unidoc/actions/workflows/build.yml)
 

Assets/css/Main.css.map

@@ -3,15 +3,15 @@ import SemanticVersions
 extension Availability
 {
     @frozen public
-    enum PlatformDomain:String, CaseIterable, Hashable, Sendable
+    enum PlatformDomain:String, CaseIterable, Equatable, Hashable, Sendable
     {
         case iOS
         case macOS
         case macCatalyst
+        case openBSD    = "OpenBSD"
         case tvOS
         case watchOS
         case windows    = "Windows"
-        case openBSD    = "OpenBSD"
 
         case iOSApplicationExtension
         case macOSApplicationExtension
@@ -29,3 +29,25 @@ extension Availability.PlatformDomain:AvailabilityDomain
     public
     typealias Unavailability = Availability.EternalRange
 }
+extension Availability.PlatformDomain:CustomStringConvertible
+{
+    @inlinable public
+    var description:String
+    {
+        switch self
+        {
+        case .iOS:                              return "iOS"
+        case .macOS:                            return "macOS"
+        case .macCatalyst:                      return "Mac Catalyst"
+        case .openBSD:                          return "OpenBSD"
+        case .tvOS:                             return "tvOS"
+        case .watchOS:                          return "watchOS"
+        case .windows:                          return "Windows"
+        case .iOSApplicationExtension:          return "iOS App Extension"
+        case .macOSApplicationExtension:        return "macOS App Extension"
+        case .macCatalystApplicationExtension:  return "Mac Catalyst App Extension"
+        case .tvOSApplicationExtension:         return "tvOS App Extension"
+        case .watchOSApplicationExtension:      return "watchOS App Extension"
+        }
+    }
+}

README.md

@@ -45,7 +45,8 @@ extension Availability:JSONDecodable
                     message: message)
 
             case .platform(let domain):
-                let deprecated:Availability.AnyRange? = try json[.isUnconditionallyDeprecated]?.decode(
+                let deprecated:Availability.AnyRange? =
+                    try json[.isUnconditionallyDeprecated]?.decode(
                         as: Bool.self)
                     {
                         $0 ? .unconditionally : nil

Sources/Availability/Domains/Availability.PlatformDomain.swift

@@ -1,3 +1,4 @@
+import Availability
 import HTML
 import LexicalPaths
 import ModuleGraphs
@@ -115,6 +116,41 @@ extension Site.Docs.Decl:ApplicationPage
             }
         }
 
+        let availability:Availability = self.master.signature.availability
+        if  let notice:String = availability.notice
+        {
+            main[.section, { $0.class = "deprecation" }] { $0[.p] = notice }
+        }
+        else if !availability.isEmpty
+        {
+            main[.section, { $0.class = "availability" }]
+            {
+                $0[.dl]
+                {
+                    if  let badge:String = availability.agnostic[.swift]?.badge
+                    {
+                        $0[.dt] = "Swift"
+                        $0[.dd] = badge
+                    }
+                    if  let badge:String = availability.agnostic[.swiftPM]?.badge
+                    {
+                        $0[.dt] = "SwiftPM"
+                        $0[.dd] = badge
+                    }
+
+                    for platform:Availability.PlatformDomain in
+                        Availability.PlatformDomain.allCases
+                    {
+                        if  let badge:String = availability.platforms[platform]?.badge
+                        {
+                            $0[.dt] = "\(platform)"
+                            $0[.dd] = badge
+                        }
+                    }
+                }
+            }
+        }
+
         main[.section, { $0.class = "declaration" }]
         {
             $0[.pre]

Sources/SymbolGraphParts/Availability/Availability (ext).swift

@@ -0,0 +1,11 @@
+import Availability
+
+extension Availability
+{
+    var notice:String?
+    {
+        self.universal?.notice ??
+        self.agnostic[.swift]?.notice("Swift") ??
+        self.agnostic[.swiftPM]?.notice("SwiftPM")
+    }
+}

Sources/UnidocPages/Templates/Site.Docs.Decl.swift

@@ -0,0 +1,97 @@
+import Availability
+
+extension Availability.Clauses<Availability.UniversalDomain>
+{
+    var notice:String?
+    {
+        guard case .unconditionally? = self.deprecated
+        else
+        {
+            return nil
+        }
+        if  let name:String = self.renamed
+        {
+            return "This declaration is deprecated. It has been renamed to \(name)."
+        }
+        else if
+            let message:String = self.message
+        {
+            return "This declaration is deprecated: \(message)"
+        }
+        else
+        {
+            return "This declaration is deprecated."
+        }
+    }
+}
+extension Availability.Clauses<Availability.AgnosticDomain>
+{
+    func notice(_ tool:String) -> String?
+    {
+        var prose:String
+        switch (obsoleted: self.obsoleted, deprecated: self.deprecated)
+        {
+        case (obsoleted: let version?, _):
+            prose = "This declaration was obsoleted in \(tool) \(version)"
+
+        case (nil, deprecated: .since(let version?)?):
+            prose = "This declaration was deprecated in \(tool) \(version)"
+
+        case (nil, deprecated: .since(nil)?):
+            prose = "This declaration is deprecated"
+
+        case (nil, nil):
+            return nil
+        }
+
+        if  let name:String = self.renamed
+        {
+            prose += ". It has been renamed to \(name)."
+        }
+        else if
+            let message:String = self.message
+        {
+            prose += ": \(message)"
+        }
+        else
+        {
+            prose += "."
+        }
+
+        return prose
+    }
+
+    var badge:String?
+    {
+        self.introduced.map { "\($0)+" }
+    }
+}
+extension Availability.Clauses<Availability.PlatformDomain>
+{
+    var badge:String?
+    {
+        switch
+        (
+            unavailable: self.unavailable,
+            deprecated: self.deprecated,
+            obsoleted: self.obsoleted,
+            introduced: self.introduced
+        )
+        {
+        case (unavailable: .unconditionally?, _, _, _):
+            return "unavailable"
+
+        case (nil, deprecated: _?, _, _):
+            return "deprecated"
+
+        case (nil, nil, obsoleted: _?, _):
+            return "obsoleted"
+
+        case (nil, nil, nil, introduced: let version?):
+            return "\(version)+"
+
+        case (nil, nil, nil, nil):
+            return nil
+        }
+    }
+}

Sources/UnidocPages/UI/Availability (ext).swift

@@ -3,6 +3,12 @@ $light-background-pink: rgb(255, 224, 239);
 $light-foreground: rgb(22, 22, 22);
 $light-foreground-semi: rgb(109, 109, 109);
 
+$light-foreground-elevated: rgb(223, 223, 223);
+$light-foreground-elevated-shadow: rgb(172, 172, 172);
+
+$light-coral-elevated: rgb(255, 103, 103);
+$light-coral-elevated-shadow: rgb(235, 75, 75);
+
 $light-code-well: rgb(233, 233, 233);
 $light-snippet-line-number: rgb(192, 192, 192);