Merge pull request #400 from tayloraswift/unidoc-version

enable printing the tool version with `unidoc --version`

Author: tayloraswift

Package.swift

@@ -148,6 +148,11 @@ let package:Package = .init(
                 .product(name: "OrderedCollections", package: "swift-collections"),
             ]),
 
+        .target(name: "_GitVersion",
+            cSettings: [
+                .define("SWIFTPM_GIT_VERSION", to: "\"\(version)\"")
+            ]),
+
         .target(name: "AvailabilityDomain"),
 
         .target(name: "Availability",
@@ -476,6 +481,7 @@ let package:Package = .init(
 
         .target(name: "UnidocCLI",
             dependencies: [
+                .target(name: "_GitVersion"),
                 .target(name: "System_ArgumentParser"),
                 .target(name: "UnidocServer"),
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
@@ -771,3 +777,16 @@ for target:PackageDescription.Target in package.targets
         $0 = settings
     } (&target.swiftSettings)
 }
+
+var version:String
+{
+    if  let git:GitInformation = Context.gitInformation
+    {
+        let base:String = git.currentTag ?? git.currentCommit
+        return git.hasUncommittedChanges ? "\(base) (modified)" : base
+    }
+    else
+    {
+        return "(untracked)"
+    }
+}

Sources/UnidocCLI/Unidoc (ext).swift

@@ -0,0 +1,10 @@
+import _GitVersion
+
+extension Unidoc
+{
+    public
+    static var version:String
+    {
+        .init(cString: _GitVersion.swiftpm_git_version())
+    }
+}

Sources/_GitVersion/include/swiftpm_git_version.h

@@ -0,0 +1,6 @@
+#if !defined(SWIFTPM_GIT_VERSION_H)
+#define SWIFTPM_GIT_VERSION_H
+
+extern const char * swiftpm_git_version(void);
+
+#endif

Sources/_GitVersion/swiftpm_git_version.c

@@ -0,0 +1,6 @@
+#include "swiftpm_git_version.h"
+
+const char * swiftpm_git_version(void)
+{
+    return SWIFTPM_GIT_VERSION;
+}

Sources/unidoc-linkerd/Main.swift

@@ -32,13 +32,22 @@ struct Main
         name: [.customLong("assume-encrypted")],
         help: "Assume that the connection is encrypted")
     var assumeEncrypted:Bool = false
+
+    @Flag(name: [.customLong("version")], help: "Print version information and exit")
+    var version:Bool = false
 }
 
 @main
 extension Main:AsyncParsableCommand
 {
     func run() async throws
     {
+        if  self.version
+        {
+            print(Unidoc.version)
+            return
+        }
+
         NIOSingletons.groupLoopCountSuggestion = 2
 
         let clientIdentity:NIOSSLContext = try .clientDefault

Sources/unidoc-tools/Main.swift

@@ -2,13 +2,29 @@ import ArgumentParser
 import SymbolGraphCompiler
 
 @main
-struct Main:AsyncParsableCommand
+struct Main
 {
-    static let configuration:CommandConfiguration = .init(subcommands: [
-            SSGC.CompileCommand.self,
-            Unidoc.InitCommand.self,
-            Unidoc.LocalCommand.self,
-            Unidoc.PreviewCommand.self,
-            Unidoc.ListAssetsCommand.self,
-        ])
+    @Flag(name: [.customLong("version")], help: "Print version information and exit")
+    var version:Bool = false
+}
+extension Main:AsyncParsableCommand
+{
+    static var configuration:CommandConfiguration
+    {
+        .init(subcommands: [
+                SSGC.CompileCommand.self,
+                Unidoc.InitCommand.self,
+                Unidoc.LocalCommand.self,
+                Unidoc.PreviewCommand.self,
+                Unidoc.ListAssetsCommand.self,
+            ])
+    }
+
+    func run() async throws
+    {
+        if  self.version
+        {
+            print(Unidoc.version)
+        }
+    }
 }