rename HTML types to use uppercase acronyms

QuietMisdreavus · QuietMisdreavus · commit ec81e2408a7a · 2023-07-10T13:56:45.000-06:00
diff --git a/Sources/Markdown/Markdown.docc/Markdown/FormatterAndOptions.md b/Sources/Markdown/Markdown.docc/Markdown/FormatterAndOptions.md
@@ -5,11 +5,11 @@
 ### Formatter
 
 - ``MarkupFormatter``
-- ``HtmlFormatter``
+- ``HTMLFormatter``
 
 ### Options
 
 - ``MarkupDumpOptions``
-- ``HtmlFormatterOptions``
+- ``HTMLFormatterOptions``
 
 <!-- Copyright (c) 2021-2022 Apple Inc and the Swift Project authors. All Rights Reserved. -->
diff --git a/Sources/Markdown/Walker/Walkers/HTMLFormatter.swift b/Sources/Markdown/Walker/Walkers/HTMLFormatter.swift
@@ -10,8 +10,8 @@
 
 import Foundation
 
-/// Options given to the ``HtmlFormatter``.
-public struct HtmlFormatterOptions: OptionSet {
+/// Options given to the ``HTMLFormatter``.
+public struct HTMLFormatterOptions: OptionSet {
     public var rawValue: UInt
     public init(rawValue: UInt) {
         self.rawValue = rawValue
@@ -29,36 +29,36 @@ public struct HtmlFormatterOptions: OptionSet {
     ///   ```markdown
     ///   > This is a compound sentence: It contains two clauses separated by a colon.
     ///   ```
-    public static let parseAsides = HtmlFormatterOptions(rawValue: 1 << 0)
+    public static let parseAsides = HTMLFormatterOptions(rawValue: 1 << 0)
 
     /// Parse inline attributes as JSON and use the `"class"` property as the resulting span's `class`.
-    public static let parseInlineAttributeClass = HtmlFormatterOptions(rawValue: 1 << 1)
+    public static let parseInlineAttributeClass = HTMLFormatterOptions(rawValue: 1 << 1)
 }
 
 /// A ``MarkupWalker`` that prints rendered HTML for a given ``Markup`` tree.
-public struct HtmlFormatter: MarkupWalker {
+public struct HTMLFormatter: MarkupWalker {
     /// The resulting HTML built up after printing.
     public var result = ""
 
-    let options: HtmlFormatterOptions
+    let options: HTMLFormatterOptions
 
     var inTableHead = false
     var tableColumnAlignments: [Table.ColumnAlignment?]? = nil
     var currentTableColumn = 0
 
-    public init(options: HtmlFormatterOptions = []) {
+    public init(options: HTMLFormatterOptions = []) {
         self.options = options
     }
 
     /// Format HTML for the given markup tree.
-    public static func format(_ markup: Markup, options: HtmlFormatterOptions = []) -> String {
-        var walker = HtmlFormatter(options: options)
+    public static func format(_ markup: Markup, options: HTMLFormatterOptions = []) -> String {
+        var walker = HTMLFormatter(options: options)
         walker.visit(markup)
         return walker.result
     }
 
     /// Format HTML for the given input text.
-    public static func format(_ inputString: String, options: HtmlFormatterOptions = []) -> String {
+    public static func format(_ inputString: String, options: HTMLFormatterOptions = []) -> String {
         let document = Document(parsing: inputString)
         return format(document, options: options)
     }
diff --git a/Sources/markdown-tool/Commands/PrintHTMLCommand.swift b/Sources/markdown-tool/Commands/PrintHTMLCommand.swift
@@ -13,7 +13,7 @@ import Markdown
 
 extension MarkdownCommand {
     /// A command to render HTML for given Markdown content.
-    struct PrintHtml: ParsableCommand {
+    struct PrintHTML: ParsableCommand {
         static var configuration = CommandConfiguration(commandName: "print-html", abstract: "Convert Markdown content into HTML")
 
         @Argument(
@@ -44,15 +44,15 @@ extension MarkdownCommand {
                 (_, document) = try MarkdownCommand.parseStandardInput(options: [])
             }
 
-            var formatterOptions = HtmlFormatterOptions()
+            var formatterOptions = HTMLFormatterOptions()
             if parseAsides {
                 formatterOptions.insert(.parseAsides)
             }
             if parseInlineAttributeClass {
                 formatterOptions.insert(.parseInlineAttributeClass)
             }
 
-            print(HtmlFormatter.format(document, options: formatterOptions))
+            print(HTMLFormatter.format(document, options: formatterOptions))
         }
     }
 }
diff --git a/Sources/markdown-tool/main.swift b/Sources/markdown-tool/main.swift
@@ -27,7 +27,7 @@ struct MarkdownCommand: ParsableCommand {
     static let configuration = CommandConfiguration(commandName: "markdown", shouldDisplay: false, subcommands: [
         DumpTree.self,
         Format.self,
-        PrintHtml.self,
+        PrintHTML.self,
     ])
 
     static func parseFile(at path: String, options: ParseOptions) throws -> (source: String, parsed: Document) {
diff --git a/Tests/MarkdownTests/Visitors/HTMLFormatterTests.swift b/Tests/MarkdownTests/Visitors/HTMLFormatterTests.swift
@@ -11,7 +11,7 @@
 import XCTest
 @testable import Markdown
 
-final class HtmlFormatterTests: XCTestCase {
+final class HTMLFormatterTests: XCTestCase {
     func testFormatEverything() {
         let expectedDump = """
         <h1>Header</h1>
@@ -67,7 +67,7 @@ final class HtmlFormatterTests: XCTestCase {
 
         """ // The rendered output contains a trailing newline
 
-        XCTAssertEqual(HtmlFormatter.format(everythingDocument), expectedDump)
+        XCTAssertEqual(HTMLFormatter.format(everythingDocument), expectedDump)
     }
 
     func testFormatAsides() {
@@ -87,7 +87,7 @@ final class HtmlFormatterTests: XCTestCase {
 
         """
 
-        XCTAssertEqual(HtmlFormatter.format(inputText, options: [.parseAsides]), expectedOutput)
+        XCTAssertEqual(HTMLFormatter.format(inputText, options: [.parseAsides]), expectedOutput)
     }
 
     // JSON5 parsing (which allows property names without quotes) is only available in Apple Foundation
@@ -107,10 +107,10 @@ final class HtmlFormatterTests: XCTestCase {
 
             """
 
-            var visitor = HtmlFormatter()
+            var visitor = HTMLFormatter()
             visitor.visit(document)
 
-            XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)
+            XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)
         }
 
         do {
@@ -120,7 +120,7 @@ final class HtmlFormatterTests: XCTestCase {
             """
 
             XCTAssertEqual(
-                HtmlFormatter.format(inputText, options: [.parseInlineAttributeClass]),
+                HTMLFormatter.format(inputText, options: [.parseInlineAttributeClass]),
                 expectedOutput
             )
         }
@@ -139,10 +139,10 @@ final class HtmlFormatterTests: XCTestCase {
 
             """
 
-            var visitor = HtmlFormatter()
+            var visitor = HTMLFormatter()
             visitor.visit(document)
 
-            XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)
+            XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)
         }
 
         do {
@@ -152,7 +152,7 @@ final class HtmlFormatterTests: XCTestCase {
             """
 
             XCTAssertEqual(
-                HtmlFormatter.format(inputText, options: [.parseInlineAttributeClass]),
+                HTMLFormatter.format(inputText, options: [.parseInlineAttributeClass]),
                 expectedOutput
             )
         }
@@ -184,7 +184,7 @@ final class HtmlFormatterTests: XCTestCase {
 
             """
 
-            XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)
+            XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)
         }
 
         do {
@@ -212,7 +212,7 @@ final class HtmlFormatterTests: XCTestCase {
 
             """
 
-            XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)
+            XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)
         }
 
         do {
@@ -239,7 +239,7 @@ final class HtmlFormatterTests: XCTestCase {
 
             """
 
-            XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)
+            XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)
         }
 
         do {
@@ -271,7 +271,7 @@ final class HtmlFormatterTests: XCTestCase {
 
             """
 
-            XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)
+            XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)
         }
 
         do {
@@ -304,7 +304,7 @@ final class HtmlFormatterTests: XCTestCase {
 
             """
 
-            XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)
+            XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ import Markdown`
`13`	`13`
`14`	`14`	`extension MarkdownCommand {`
`15`	`15`	`/// A command to render HTML for given Markdown content.`
`16`		`- struct PrintHtml: ParsableCommand {`
	`16`	`+ struct PrintHTML: ParsableCommand {`
`17`	`17`	`static var configuration = CommandConfiguration(commandName: "print-html", abstract: "Convert Markdown content into HTML")`
`18`	`18`
`19`	`19`	`@Argument(`
`@@ -44,15 +44,15 @@ extension MarkdownCommand {`
`44`	`44`	`(_, document) = try MarkdownCommand.parseStandardInput(options: [])`
`45`	`45`	`}`
`46`	`46`
`47`		`- var formatterOptions = HtmlFormatterOptions()`
	`47`	`+ var formatterOptions = HTMLFormatterOptions()`
`48`	`48`	`if parseAsides {`
`49`	`49`	`formatterOptions.insert(.parseAsides)`
`50`	`50`	`}`
`51`	`51`	`if parseInlineAttributeClass {`
`52`	`52`	`formatterOptions.insert(.parseInlineAttributeClass)`
`53`	`53`	`}`
`54`	`54`
`55`		`- print(HtmlFormatter.format(document, options: formatterOptions))`
	`55`	`+ print(HTMLFormatter.format(document, options: formatterOptions))`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`import XCTest`
`12`	`12`	`@testable import Markdown`
`13`	`13`
`14`		`-final class HtmlFormatterTests: XCTestCase {`
	`14`	`+final class HTMLFormatterTests: XCTestCase {`
`15`	`15`	`func testFormatEverything() {`
`16`	`16`	`let expectedDump = """`
`17`	`17`	`<h1>Header</h1>`
`@@ -67,7 +67,7 @@ final class HtmlFormatterTests: XCTestCase {`
`67`	`67`
`68`	`68`	`""" // The rendered output contains a trailing newline`
`69`	`69`
`70`		`- XCTAssertEqual(HtmlFormatter.format(everythingDocument), expectedDump)`
	`70`	`+ XCTAssertEqual(HTMLFormatter.format(everythingDocument), expectedDump)`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`func testFormatAsides() {`
`@@ -87,7 +87,7 @@ final class HtmlFormatterTests: XCTestCase {`
`87`	`87`
`88`	`88`	`"""`
`89`	`89`
`90`		`- XCTAssertEqual(HtmlFormatter.format(inputText, options: [.parseAsides]), expectedOutput)`
	`90`	`+ XCTAssertEqual(HTMLFormatter.format(inputText, options: [.parseAsides]), expectedOutput)`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`// JSON5 parsing (which allows property names without quotes) is only available in Apple Foundation`
`@@ -107,10 +107,10 @@ final class HtmlFormatterTests: XCTestCase {`
`107`	`107`
`108`	`108`	`"""`
`109`	`109`
`110`		`- var visitor = HtmlFormatter()`
	`110`	`+ var visitor = HTMLFormatter()`
`111`	`111`	`visitor.visit(document)`
`112`	`112`
`113`		`- XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)`
	`113`	`+ XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`do {`
`@@ -120,7 +120,7 @@ final class HtmlFormatterTests: XCTestCase {`
`120`	`120`	`"""`
`121`	`121`
`122`	`122`	`XCTAssertEqual(`
`123`		`- HtmlFormatter.format(inputText, options: [.parseInlineAttributeClass]),`
	`123`	`+ HTMLFormatter.format(inputText, options: [.parseInlineAttributeClass]),`
`124`	`124`	`expectedOutput`
`125`	`125`	`)`
`126`	`126`	`}`
`@@ -139,10 +139,10 @@ final class HtmlFormatterTests: XCTestCase {`
`139`	`139`
`140`	`140`	`"""`
`141`	`141`
`142`		`- var visitor = HtmlFormatter()`
	`142`	`+ var visitor = HTMLFormatter()`
`143`	`143`	`visitor.visit(document)`
`144`	`144`
`145`		`- XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)`
	`145`	`+ XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`do {`
`@@ -152,7 +152,7 @@ final class HtmlFormatterTests: XCTestCase {`
`152`	`152`	`"""`
`153`	`153`
`154`	`154`	`XCTAssertEqual(`
`155`		`- HtmlFormatter.format(inputText, options: [.parseInlineAttributeClass]),`
	`155`	`+ HTMLFormatter.format(inputText, options: [.parseInlineAttributeClass]),`
`156`	`156`	`expectedOutput`
`157`	`157`	`)`
`158`	`158`	`}`
`@@ -184,7 +184,7 @@ final class HtmlFormatterTests: XCTestCase {`
`184`	`184`
`185`	`185`	`"""`
`186`	`186`
`187`		`- XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)`
	`187`	`+ XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`do {`
`@@ -212,7 +212,7 @@ final class HtmlFormatterTests: XCTestCase {`
`212`	`212`
`213`	`213`	`"""`
`214`	`214`
`215`		`- XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)`
	`215`	`+ XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)`
`216`	`216`	`}`
`217`	`217`
`218`	`218`	`do {`
`@@ -239,7 +239,7 @@ final class HtmlFormatterTests: XCTestCase {`
`239`	`239`
`240`	`240`	`"""`
`241`	`241`
`242`		`- XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)`
	`242`	`+ XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)`
`243`	`243`	`}`
`244`	`244`
`245`	`245`	`do {`
`@@ -271,7 +271,7 @@ final class HtmlFormatterTests: XCTestCase {`
`271`	`271`
`272`	`272`	`"""`
`273`	`273`
`274`		`- XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)`
	`274`	`+ XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)`
`275`	`275`	`}`
`276`	`276`
`277`	`277`	`do {`
`@@ -304,7 +304,7 @@ final class HtmlFormatterTests: XCTestCase {`
`304`	`304`
`305`	`305`	`"""`
`306`	`306`
`307`		`- XCTAssertEqual(HtmlFormatter.format(inputText), expectedOutput)`
	`307`	`+ XCTAssertEqual(HTMLFormatter.format(inputText), expectedOutput)`
`308`	`308`	`}`
`309`	`309`	`}`
`310`	`310`	`}`