Merge pull request swiftlang#94 from SwiftDocOrg/add-version-number

Add swift-doc version number

Author: mattt

Changelog.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   #65 by @kean.
 - Added asset pipeline for CSS assets.
   #49 by @kaishin.
+- Add `swift-doc` version number to command and generated output.
+  #94 by @mattt.
 
 ### Changed
 

Package.resolved

@@ -18,7 +18,7 @@ let package = Package(
         .package(url: "https://github.com/NSHipster/HypertextLiteral.git", .upToNextMinor(from: "0.0.2")),
         .package(url: "https://github.com/SwiftDocOrg/Markup.git", .upToNextMinor(from: "0.0.3")),
         .package(url: "https://github.com/NSHipster/SwiftSyntaxHighlighter.git", .revision("1.0.0")),
-        .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "0.0.2")),
+        .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "0.0.5")),
         .package(url: "https://github.com/apple/swift-log.git", .upToNextMinor(from: "1.2.0")),
         .package(url: "https://github.com/NSHipster/swift-log-github-actions.git", .upToNextMinor(from: "0.0.1")),
     ],

Package.swift

@@ -46,9 +46,10 @@ $ make install
 
     OVERVIEW: A utility for generating documentation for Swift code.
 
-    USAGE: swift-doc <subcommand>
+    USAGE: swift doc <subcommand>
 
     OPTIONS:
+      --version               Show the version.
       -h, --help              Show help information.
 
     SUBCOMMANDS:
@@ -67,7 +68,7 @@ $ make install
 
     OVERVIEW: Generates Swift documentation
 
-    USAGE: swift-doc generate [<inputs> ...] --module-name <module-name> [--output <output>] [--format <format>]
+    USAGE: swift doc generate [<inputs> ...] --module-name <module-name> [--output <output>] [--format <format>]
 
     ARGUMENTS:
       <inputs>                One or more paths to Swift files 
@@ -111,7 +112,7 @@ $ Documentation/
 
     OVERVIEW: Generates documentation coverage statistics for Swift files
 
-    USAGE: swift-doc coverage [<inputs> ...] [--output <output>]
+    USAGE: swift doc coverage [<inputs> ...] [--output <output>]
 
     ARGUMENTS:
       <inputs>                One or more paths to Swift files 
@@ -160,7 +161,7 @@ please reach out by [opening an Issue][open an issue]!
 
     OVERVIEW: Generates diagram of Swift symbol relationships
 
-    USAGE: swift-doc diagram [<inputs> ...]
+    USAGE: swift doc diagram [<inputs> ...]
 
     ARGUMENTS:
       <inputs>                One or more paths to Swift files 

README.md

@@ -25,7 +25,7 @@ struct FooterPage: Page {
 
         return Document {
             Fragment {
-                "Generated at \(timestamp) using [swift-doc](\(href))."
+                "Generated at \(timestamp) using [swift-doc](\(href)) \(SwiftDoc.configuration.version)."
             }
         }
     }
@@ -36,7 +36,7 @@ struct FooterPage: Page {
 
         return #"""
         <p>
-            Generated on <time datetime=\#(timestamp)>\#(dateString)</time> using <a href=\#(href)>swift-doc</a>.
+            Generated on <time datetime=\#(timestamp)>\#(dateString)</time> using <a href=\#(href)>swift-doc</a> <span class="version">\#(SwiftDoc.configuration.version)</span>.
         </p>
         """#
     }

Sources/swift-doc/Supporting Types/Pages/FooterPage.swift

@@ -21,7 +21,9 @@ var standardError = FileHandle.standardError
 
 struct SwiftDoc: ParsableCommand {
     static var configuration = CommandConfiguration(
+        commandName: "swift doc",
         abstract: "A utility for generating documentation for Swift code.",
+        version: "1.0.0-beta.2",
         subcommands: [Generate.self, Coverage.self, Diagram.self]
     )
 }