Add some metadata to JSON

To know when it was generated and by what generator. Also convert dates on specs to ISO8601.

Author: mac-cain13

Sources/webtags/Command.swift

@@ -18,7 +18,7 @@ struct Command: ParsableCommand {
         commandName: "webtags",
         abstract: "Element definitions from web specifications.",
         discussion: "Generates JSON output describing all elements, attributes and predefined attribute values from the given web browser specifications.",
-        version: "0.1"
+        version: "0.1-unstable"
     )
 
     @Option(name: .customLong("specs"), help: "Short names of the specs to parse and output.")
@@ -38,6 +38,8 @@ struct Command: ParsableCommand {
         LoggingSystem.bootstrap(StreamLogHandler.standardError)
         let logger = Logger(label: "WebTags")
             .withLogLevel(logLevel)
+        
+        let runStartedDate = Date()
         logger.notice("Started run.", metadata: ["logLevel": "\(logLevel)", "webRefIndex": "\(webRefIndex)", "specsToGenerate": "\(specsToGenerate.joined(separator: ","))"], source: "\(Self.self)")
 
         // Parse URL
@@ -62,17 +64,20 @@ struct Command: ParsableCommand {
                 .filter { specsToGenerate.contains($0.shortname) }
                 .map { try WebRefCrawlResultTransformer(crawlResult: $0, baseURL: indexURL, parentLogger: logger) }
                 .map { try $0.transform() }
-            logger.info("Specs parsed.", metadata: ["specsToGenerate": "\(specsToGenerate.joined(separator: ","))"], source: "\(Self.self)")            
+            logger.info("Specs parsed.", metadata: ["specsToGenerate": "\(specsToGenerate.joined(separator: ","))"], source: "\(Self.self)")
+            
+            let webTags = WebTags(generatedAt: runStartedDate, generatedSpecs: specsToGenerate, specs: parsedSpecs)
 
             // Encode output as JSON
             logger.debug("Generating JSON...", source: "\(Self.self)")
             let encoder = JSONEncoder()
+            encoder.dateEncodingStrategy = .iso8601
             if prettyPrint {
                 encoder.outputFormatting = [.prettyPrinted, .sortedKeys, .withoutEscapingSlashes]
             } else {
                 encoder.outputFormatting = [.withoutEscapingSlashes]
             }
-            let jsonData = try encoder.encode(parsedSpecs)
+            let jsonData = try encoder.encode(webTags)
             guard let jsonString = String(data: jsonData, encoding: .utf8) else {
                 throw EncodingFailedError(message: "Failed to convert JSON data to string.")
             }

Sources/webtags/Output.swift

@@ -12,12 +12,21 @@ private let globalElementIdentifiers: Set<String> = [
     "core-attributes", // SVG2
 ]
 
+struct WebTags: Encodable {
+    let generatedAt: Date
+    let generatedSpecs: [String]
+    let generator = Command.configuration.commandName
+    let generatorVersion = Command.configuration.version
+    let generatorUrl = "https://github.com/nonstrict-hq/WebTags"
+    let specs: [Spec]
+}
+
 struct Spec: Encodable {
     let organization: String
     let title: String
     let shortname: String
     let url: URL
-    let date: String
+    let date: Date
 
     let globalAttributes: [Attribute]
     let elements: [Element]
@@ -35,12 +44,24 @@ struct Spec: Encodable {
         case elements
     }
 
+    private static let dateFormatter = {
+        let formatter = DateFormatter()
+        formatter.locale = Locale(identifier: "en_US_POSIX")
+        formatter.timeZone = TimeZone(secondsFromGMT: 0)
+        formatter.dateFormat = "d MMMM yyyy"
+        return formatter
+    }()
+    
     init(crawlResult: WebRefCrawl.Result, crawledElements: [WebRefCrawl.Element], crawledDfns: [WebRefCrawl.Dfn]) throws {
         organization = crawlResult.organization
         title = crawlResult.title
         shortname = crawlResult.shortname
         url = crawlResult.url
-        date = crawlResult.date
+        
+        guard let date = Spec.dateFormatter.date(from: crawlResult.date) else {
+            throw InvalidCrawlResultError(message: "Invalid date: \(crawlResult.date)", result: crawlResult)
+        }
+        self.date = date
 
         let attributes = try crawledDfns.compactMap(Attribute.init)
         let attributeValues = try crawledDfns.compactMap(AttributeValue.init)