sort the conforming types groups

Author: tayloraswift

Sources/Unidoc/Unidoc.Scalar.swift

@@ -19,6 +19,11 @@ extension Unidoc
         }
     }
 }
+extension Unidoc.Scalar:Identifiable
+{
+    @inlinable public
+    var id:Self { self }
+}
 extension Unidoc.Scalar
 {
     @available(*, deprecated, renamed: "edition")

Sources/UnidocDB/Mongo.CollectionModel.swift

@@ -499,7 +499,9 @@ extension Mongo.CollectionModel
         return deletions.deleted
     }
 }
-extension Mongo.CollectionModel<Unidoc.Scalar>
+//  TODO: we need to unify ``Unidoc.Scalar`` and ``Unidoc.Group`, most likely by introducing
+//  a new type ``Unidoc.Vertex``.
+extension Mongo.CollectionModel // where Element.ID == Unidoc.Scalar
 {
     /// Deletes all records from the collection within the specified zone.
     func clear(range:Unidoc.Edition, with session:Mongo.Session) async throws

Sources/UnidocLinker/Curation/Unidoc.LexicalPriority.swift

@@ -0,0 +1,22 @@
+import LexicalPaths
+import SymbolGraphs
+
+extension Unidoc
+{
+    /// A sort priority that compares the fully-qualified names of declarations.
+    enum LexicalPriority:Equatable, Comparable
+    {
+        case available  (UnqualifiedPath, Int32)
+        case removed    (UnqualifiedPath, Int32)
+    }
+}
+extension Unidoc.LexicalPriority:Unidoc.SortPriority
+{
+    static
+    func of(decl:SymbolGraph.Decl, at index:Int32) -> Self?
+    {
+        decl.signature.availability.isGenerallyRecommended
+            ? .available(decl.path, index)
+            : .removed(decl.path, index)
+    }
+}

Sources/UnidocLinker/Curation/Unidoc.Linker.SortPriority.swift

@@ -1,6 +1,6 @@
 import Sources
 
-extension Unidoc.Linker.SortPriority
+extension Unidoc.SemanticPriority
 {
     enum Constructor:Equatable, Comparable
     {

Sources/UnidocLinker/Curation/Unidoc.Linker.SortPriority.Constructor.swift renamed to Sources/UnidocLinker/Curation/Unidoc.SemanticPriority.Constructor.swift

@@ -1,4 +1,4 @@
-extension Unidoc.Linker.SortPriority
+extension Unidoc.SemanticPriority
 {
     enum Member:Equatable, Comparable
     {

Sources/UnidocLinker/Curation/Unidoc.Linker.SortPriority.Member.swift renamed to Sources/UnidocLinker/Curation/Unidoc.SemanticPriority.Member.swift

@@ -2,7 +2,7 @@
 import Sources
 import Symbols
 
-extension Unidoc.Linker.SortPriority
+extension Unidoc.SemanticPriority
 {
     enum Phylum:Equatable, Comparable
     {
@@ -26,7 +26,7 @@ extension Unidoc.Linker.SortPriority
         case  macro
     }
 }
-extension Unidoc.Linker.SortPriority.Phylum
+extension Unidoc.SemanticPriority.Phylum
 {
     init(_ phylum:Phylum.Decl, position:SourcePosition? = nil)
     {

Sources/UnidocLinker/Curation/Unidoc.Linker.SortPriority.Phylum.swift renamed to Sources/UnidocLinker/Curation/Unidoc.SemanticPriority.Phylum.swift

@@ -0,0 +1,22 @@
+import SymbolGraphs
+
+extension Unidoc
+{
+    enum SemanticPriority:Equatable, Comparable
+    {
+        case available  (Phylum, String, Int32)
+        case removed    (Phylum, String, Int32)
+    }
+}
+extension Unidoc.SemanticPriority:Unidoc.SortPriority
+{
+    static
+    func of(decl:SymbolGraph.Decl, at index:Int32) -> Self?
+    {
+        let phylum:Phylum = .init(decl.phylum, position: decl.location?.position)
+
+        return decl.signature.availability.isGenerallyRecommended
+            ? .available(phylum, decl.path.last, index)
+            : .removed(phylum, decl.path.last, index)
+    }
+}

Sources/UnidocLinker/Curation/Unidoc.SemanticPriority.swift

@@ -0,0 +1,43 @@
+import SymbolGraphs
+import Unidoc
+
+extension Unidoc
+{
+    typealias SortPriority = _UnidocSortPriority
+}
+/// The name of this protocol is ``Unidoc.SortPriority``.
+protocol _UnidocSortPriority:Comparable
+{
+    /// Get the sort-priority of a declaration.
+    static
+    func of(decl:SymbolGraph.Decl, at index:Int32) -> Self?
+}
+extension Unidoc.SortPriority
+{
+    static
+    func of(decl:Unidoc.Scalar, in linker:borrowing Unidoc.Linker) -> Self?
+    {
+        guard
+        let graph:Unidoc.Linker.Graph = linker[decl.package]
+        else
+        {
+            return nil
+        }
+
+        return .of(decl: decl, in: graph)
+    }
+
+    static
+    func of(decl:Unidoc.Scalar, in graph:Unidoc.Linker.Graph) -> Self?
+    {
+        guard
+        let local:Int32 = decl - graph.id,
+        let decl:SymbolGraph.Decl = graph.decls[local]?.decl
+        else
+        {
+            return nil
+        }
+
+        return .of(decl: decl, at: local)
+    }
+}

Sources/UnidocLinker/Curation/Unidoc.SortPriority.swift

@@ -50,8 +50,7 @@ extension Unidoc.Conformers:Unidoc.LinkerIndexable
         .init(id: self.id.in(linker.current.id),
             culture: linker.current.id + signature.culture,
             scope: signature.conformance,
-            unconditional: self.unconditional,
-            conditional: self.conditional)
-            // do we need to sort this?
+            unconditional: linker.sort(self.unconditional, by: Unidoc.LexicalPriority.self),
+            conditional: linker.sort(self.conditional, by: Unidoc.LexicalPriority.self))
     }
 }