renamed some stuff

RandomHashTags · RandomHashTags · commit 68411711e944 · 2025-07-18T10:27:03.000-05:00
- `HTMLResultRepresentation` -&gt; `HTMLExpansionResultType`
- `representation` -&gt; `resultType`
diff --git a/Benchmarks/Benchmarks/SwiftHTMLKit/SwiftHTMLKit.swift b/Benchmarks/Benchmarks/SwiftHTMLKit/SwiftHTMLKit.swift
@@ -67,9 +67,9 @@ package struct SwiftHTMLKitTests: HTMLGenerator {
     package func dynamicHTML(_ context: HTMLContext) -> String {
         var qualities:String = ""
         for quality in context.user.qualities {
-            qualities += #html(representation: .literal, li(quality))
+            qualities += #html(resultType: .literal, li(quality))
         }
-        return #html(representation: .literal) {
+        return #html(resultType: .literal) {
             html {
                 head {
                     meta(charset: context.charset)
diff --git a/Sources/HTMLKit/HTMLKit.swift b/Sources/HTMLKit/HTMLKit.swift
@@ -10,7 +10,7 @@
 @freestanding(expression)
 public macro escapeHTML(
     encoding: HTMLEncoding = .string,
-    representation: HTMLResultRepresentation = .literal,
+    resultType: HTMLExpansionResultType = .literal,
     _ innerHTML: Sendable...
 ) -> String = #externalMacro(module: "HTMLKitMacros", type: "EscapeHTML")
 
@@ -20,7 +20,7 @@ public macro escapeHTML(
 //@available(*, deprecated, message: "innerHTML is now initialized using brackets instead of parentheses")
 public macro html<T>(
     encoding: HTMLEncoding = .string,
-    representation: HTMLResultRepresentation = .literal,
+    resultType: HTMLExpansionResultType = .literal,
     lookupFiles: [StaticString] = [],
     _ innerHTML: Sendable...
 ) -> T = #externalMacro(module: "HTMLKitMacros", type: "HTMLElementMacro")
@@ -30,7 +30,7 @@ public macro html<T>(
 @freestanding(expression)
 public macro html<T>(
     encoding: HTMLEncoding = .string,
-    representation: HTMLResultRepresentation = .literal,
+    resultType: HTMLExpansionResultType = .literal,
     lookupFiles: [StaticString] = [],
     _ innerHTML: () -> Sendable...
 ) -> T = #externalMacro(module: "HTMLKitMacros", type: "HTMLElementMacro")
@@ -39,7 +39,7 @@ public macro html<T>(
 @freestanding(expression)
 public macro anyHTML(
     encoding: HTMLEncoding = .string,
-    representation: HTMLResultRepresentation = .literal,
+    resultType: HTMLExpansionResultType = .literal,
     lookupFiles: [StaticString] = [],
     _ innerHTML: Sendable...
 ) -> any Sendable = #externalMacro(module: "HTMLKitMacros", type: "HTMLElementMacro")
@@ -51,7 +51,7 @@ public macro anyHTML(
 @freestanding(expression)
 public macro uncheckedHTML<T>(
     encoding: HTMLEncoding = .string,
-    representation: HTMLResultRepresentation = .literal,
+    resultType: HTMLExpansionResultType = .literal,
     lookupFiles: [StaticString] = [],
     _ innerHTML: Sendable...
 ) -> T = #externalMacro(module: "HTMLKitMacros", type: "HTMLElementMacro")
@@ -63,7 +63,7 @@ public macro uncheckedHTML<T>(
 @freestanding(expression)
 public macro rawHTML<T>(
     encoding: HTMLEncoding = .string,
-    representation: HTMLResultRepresentation = .literal,
+    resultType: HTMLExpansionResultType = .literal,
     lookupFiles: [StaticString] = [],
     minify: Bool = false,
     _ innerHTML: Sendable...
@@ -75,7 +75,7 @@ public macro rawHTML<T>(
 @freestanding(expression)
 public macro anyRawHTML(
     encoding: HTMLEncoding = .string,
-    representation: HTMLResultRepresentation = .literal,
+    resultType: HTMLExpansionResultType = .literal,
     lookupFiles: [StaticString] = [],
     minify: Bool = false,
     _ innerHTML: Sendable...
diff --git a/Sources/HTMLKitMacros/EscapeHTML.swift b/Sources/HTMLKitMacros/EscapeHTML.swift
@@ -11,7 +11,7 @@ enum EscapeHTML: ExpressionMacro {
             expansion: node,
             ignoresCompilerWarnings: false,
             encoding: .string,
-            representation: .literal,
+            resultType: .literal,
             key: "",
             arguments: node.arguments
         )
diff --git a/Sources/HTMLKitMacros/HTMLElement.swift b/Sources/HTMLKitMacros/HTMLElement.swift
@@ -12,7 +12,7 @@ enum HTMLElementMacro: ExpressionMacro {
             expansion: node,
             ignoresCompilerWarnings: node.macroName.text == "uncheckedHTML",
             encoding: .string,
-            representation: .literal,
+            resultType: .literal,
             key: "",
             arguments: node.arguments,
             escape: true,
diff --git a/Sources/HTMLKitMacros/RawHTML.swift b/Sources/HTMLKitMacros/RawHTML.swift
@@ -11,7 +11,7 @@ enum RawHTML: ExpressionMacro {
             expansion: node,
             ignoresCompilerWarnings: false,
             encoding: .string,
-            representation: .literal,
+            resultType: .literal,
             key: "",
             arguments: node.arguments
         )
diff --git a/Sources/HTMLKitParse/ExpandHTMLMacro.swift b/Sources/HTMLKitParse/ExpandHTMLMacro.swift
@@ -8,7 +8,7 @@ extension HTMLKitUtilities {
         var context = context
         let (string, encoding) = expandMacro(context: &context)
         let encodingResult = encodingResult(context: context, node: context.expansion, string: string, for: encoding)
-        let expandedResult = representationResult(encoding: encoding, encodedResult: encodingResult, representation: context.representation)
+        let expandedResult = representationResult(encoding: encoding, encodedResult: encodingResult, resultType: context.resultType)
         return "\(raw: expandedResult)"
     }
 
@@ -80,9 +80,9 @@ extension HTMLKitUtilities {
     static func representationResult(
         encoding: HTMLEncoding,
         encodedResult: String,
-        representation: HTMLResultRepresentationAST
+        resultType: HTMLExpansionResultTypeAST
     ) -> String {
-        switch representation {
+        switch resultType {
         case .literal:
             if encoding == .string {
                 return literal(encodedResult: encodedResult)
diff --git a/Sources/HTMLKitParse/ParseArguments.swift b/Sources/HTMLKitParse/ParseArguments.swift
@@ -27,8 +27,8 @@ extension HTMLKitUtilities {
                 switch key {
                 case "encoding":
                     context.encoding = parseEncoding(expr: child.expression) ?? .string
-                case "representation":
-                    context.representation = parseRepresentation(expr: child.expression) ?? .literal
+                case "resultType":
+                    context.resultType = parseRepresentation(expr: child.expression) ?? .literal
                 case "lookupFiles":
                     guard let array = child.expression.array?.elements else {
                         context.diagnose(DiagnosticMsg.expectedArrayExpr(expr: child.expression))
diff --git a/Sources/HTMLKitParse/ParseData.swift b/Sources/HTMLKitParse/ParseData.swift
@@ -39,7 +39,7 @@ extension HTMLKitUtilities {
             if let key = child.label?.text {
                 switch key {
                 case "encoding": context.encoding = parseEncoding(expr: child.expression) ?? .string
-                case "representation": context.representation = parseRepresentation(expr: child.expression) ?? .literal
+                case "resultType": context.resultType = parseRepresentation(expr: child.expression) ?? .literal
                 case "minify": context.minify = child.expression.boolean(context) ?? false
                 default: break
                 }
@@ -84,7 +84,7 @@ extension HTMLKitUtilities {
     }
 
     // MARK: Parse Representation
-    public static func parseRepresentation(expr: ExprSyntax) -> HTMLResultRepresentationAST? {
+    public static func parseRepresentation(expr: ExprSyntax) -> HTMLExpansionResultTypeAST? {
         switch expr.kind {
         case .memberAccessExpr:
             switch expr.memberAccess!.declName.baseName.text {
diff --git a/Sources/HTMLKitUtilities/HTMLEncoding.swift b/Sources/HTMLKitUtilities/HTMLEncoding.swift
@@ -1,5 +1,5 @@
 
-/// The value type the data should be encoded to when returned from the macro.
+/// The data type the result should be encoded to when returned from the macro.
 /// 
 /// ### Interpolation Promotion
 /// 
diff --git a/Sources/HTMLKitUtilities/HTMLExpansionContext.swift b/Sources/HTMLKitUtilities/HTMLExpansionContext.swift
@@ -17,8 +17,8 @@ public struct HTMLExpansionContext: @unchecked Sendable {
     /// `HTMLEncoding` of this expansion.
     public var encoding:HTMLEncoding
 
-    /// `HTMLResultRepresentation` of this expansion.
-    public var representation:HTMLResultRepresentationAST
+    /// `HTMLExpansionResultType` of this expansion.
+    public var resultType:HTMLExpansionResultTypeAST
 
     /// Associated attribute key responsible for the arguments.
     public var key:String
@@ -39,7 +39,7 @@ public struct HTMLExpansionContext: @unchecked Sendable {
         expansion: FreestandingMacroExpansionSyntax,
         ignoresCompilerWarnings: Bool,
         encoding: HTMLEncoding,
-        representation: HTMLResultRepresentationAST,
+        resultType: HTMLExpansionResultTypeAST,
         key: String,
         arguments: LabeledExprListSyntax,
         lookupFiles: Set<String> = [],
@@ -53,7 +53,7 @@ public struct HTMLExpansionContext: @unchecked Sendable {
         trailingClosure = expansion.trailingClosure
         self.ignoresCompilerWarnings = ignoresCompilerWarnings
         self.encoding = encoding
-        self.representation = representation
+        self.resultType = resultType
         self.key = key
         self.arguments = arguments
         self.lookupFiles = lookupFiles
diff --git a/Sources/HTMLKitUtilities/HTMLExpansionResultType.swift b/Sources/HTMLKitUtilities/HTMLExpansionResultType.swift
@@ -1,5 +1,5 @@
 
-public enum HTMLResultRepresentation: Sendable {
+public enum HTMLExpansionResultType: Sendable {
 
 
     // MARK: Literal
@@ -20,7 +20,7 @@ public enum HTMLResultRepresentation: Sendable {
     /// - Parameters:
     ///   - optimized: Whether or not to use optimized literals. Default is `true`.
     ///   - chunkSize: The maximum size of an individual literal. Default is `1024`.
-    ///   - Returns: An `Array` of encoded literals of length up-to `chunkSize`.
+    ///   - Returns: An array of encoded literals of length up-to `chunkSize`.
     case chunked(optimized: Bool = true, chunkSize: Int = 1024)
 
     #if compiler(>=6.2)
@@ -57,8 +57,8 @@ public enum HTMLResultRepresentation: Sendable {
     )
 }
 
-// MARK: HTMLResultRepresentationAST
-public enum HTMLResultRepresentationAST: Sendable {
+// MARK: HTMLExpansionResultTypeAST
+public enum HTMLExpansionResultTypeAST: Sendable {
     case literal
     //case literalOptimized
 
diff --git a/Tests/HTMLKitTests/HTMLKitTests.swift b/Tests/HTMLKitTests/HTMLKitTests.swift
@@ -89,57 +89,57 @@ extension HTMLKitTests {
     @Test
     func representations() {
         let yeah = "yeah"
-        let _:String = #html(representation: .literal) {
+        let _:String = #html(resultType: .literal) {
             div("oh yeah")
         }
-        let _:String = #html(representation: .literal) {
+        let _:String = #html(resultType: .literal) {
             div("oh \(yeah)")
         }
-        /*let _:String = #html(representation: .literalOptimized) {
+        /*let _:String = #html(resultType: .literalOptimized) {
             div("oh yeah")
         }
-        let _:String = #html(representation: .literalOptimized) {
+        let _:String = #html(resultType: .literalOptimized) {
             div("oh \(yeah)")
         }*/
 
-        let _:[String] = #html(representation: .chunked()) {
+        let _:[String] = #html(resultType: .chunked()) {
             div("oh yeah")
         }
-        let _:[StaticString] = #html(representation: .chunked()) {
+        let _:[StaticString] = #html(resultType: .chunked()) {
             div("oh yeah")
         }
-        /*let _:[String] = #html(representation: .chunked(chunkSize: 3)) { // TODO: fix
+        /*let _:[String] = #html(resultType: .chunked(chunkSize: 3)) { // TODO: fix
             div("oh \(yeah)")
         }*/
 
-        let _:AsyncStream<String> = #html(representation: .streamed()) {
+        let _:AsyncStream<String> = #html(resultType: .streamed()) {
             div("oh yeah")
         }
-        let _:AsyncStream<StaticString> = #html(representation: .streamed()) {
+        let _:AsyncStream<StaticString> = #html(resultType: .streamed()) {
             div("oh yeah")
         }
-        let _:AsyncStream<String> = #html(representation: .streamed(chunkSize: 3)) {
+        let _:AsyncStream<String> = #html(resultType: .streamed(chunkSize: 3)) {
             div("oh yeah")
         }
-        let _:AsyncStream<StaticString> = #html(representation: .streamed(chunkSize: 3)) {
+        let _:AsyncStream<StaticString> = #html(resultType: .streamed(chunkSize: 3)) {
             div("oh yeah")
         }
-        /*let _:AsyncStream<String> = #html(representation: .streamed(chunkSize: 3)) {
+        /*let _:AsyncStream<String> = #html(resultType: .streamed(chunkSize: 3)) {
             div("oh\(yeah)") // TODO: fix
         }*/
 
-        let _:AsyncStream<String> = #html(representation: .streamedAsync()) {
+        let _:AsyncStream<String> = #html(resultType: .streamedAsync()) {
             div("oh yeah")
         }
-        let _:AsyncStream<String> = #html(representation: .streamedAsync(chunkSize: 3)) {
+        let _:AsyncStream<String> = #html(resultType: .streamedAsync(chunkSize: 3)) {
             div("oh yeah")
         }
-        let _:AsyncStream<String> = #html(representation: .streamedAsync({ _ in
+        let _:AsyncStream<String> = #html(resultType: .streamedAsync({ _ in
             try await Task.sleep(for: .milliseconds(50))
         })) {
             div("oh yeah")
         }
-        let _:AsyncStream<String> = #html(representation: .streamedAsync(chunkSize: 3, { _ in
+        let _:AsyncStream<String> = #html(resultType: .streamedAsync(chunkSize: 3, { _ in
             try await Task.sleep(for: .milliseconds(50))
         })) {
             div("oh yeah")
diff --git a/Tests/HTMLKitTests/InterpolationTests.swift b/Tests/HTMLKitTests/InterpolationTests.swift
@@ -72,7 +72,7 @@ struct InterpolationTests {
     // MARK: multi-line func
     @Test func interpolationMultilineFunc() {
         var expected:String = "<div>Bikini Bottom: Spongebob Squarepants, Patrick Star, Squidward Tentacles, Mr. Krabs, Sandy Cheeks, Pearl Krabs</div>"
-        var string:String = #html(representation: .literal,
+        var string:String = #html(resultType: .literal,
             div(
                 "Bikini Bottom: ",
                 InterpolationTests.spongebobCharacter(
diff --git a/Tests/HTMLKitTests/StreamTests.swift b/Tests/HTMLKitTests/StreamTests.swift
@@ -24,7 +24,7 @@ struct StreamTests {
             }
         )
         var test:AsyncStream<String> = #html(
-            representation: .streamedAsync(chunkSize: 50, { _ in
+            resultType: .streamedAsync(chunkSize: 50, { _ in
                 try await Task.sleep(for: .milliseconds(5))
             })) {
             html {
@@ -52,7 +52,7 @@ struct StreamTests {
         #expect(receivedHTML == expected)
 
         test = #html(
-            representation: .streamedAsync(
+            resultType: .streamedAsync(
                 chunkSize: 40, { yieldIndex in
                     try await Task.sleep(for: .milliseconds((yieldIndex+1) * 5))
                 }
@@ -107,7 +107,7 @@ extension StreamTests {
         )
 
         var test:AsyncStream<String> = #html(
-            representation: .streamedAsync(chunkSize: 50, { _ in
+            resultType: .streamedAsync(chunkSize: 50, { _ in
                 try await Task.sleep(for: .milliseconds(5))
             })) {
             html {
@@ -136,7 +136,7 @@ extension StreamTests {
         #expect(receivedHTML == expected)
 
         test = #html(
-            representation: .streamedAsync(chunkSize: 200, { _ in
+            resultType: .streamedAsync(chunkSize: 200, { _ in
                 try await Task.sleep(for: .milliseconds(5))
             })) {
             html {

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ enum EscapeHTML: ExpressionMacro {`
`11`	`11`	`expansion: node,`
`12`	`12`	`ignoresCompilerWarnings: false,`
`13`	`13`	`encoding: .string,`
`14`		`- representation: .literal,`
	`14`	`+ resultType: .literal,`
`15`	`15`	`key: "",`
`16`	`16`	`arguments: node.arguments`
`17`	`17`	`)`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ enum RawHTML: ExpressionMacro {`
`11`	`11`	`expansion: node,`
`12`	`12`	`ignoresCompilerWarnings: false,`
`13`	`13`	`encoding: .string,`
`14`		`- representation: .literal,`
	`14`	`+ resultType: .literal,`
`15`	`15`	`key: "",`
`16`	`16`	`arguments: node.arguments`
`17`	`17`	`)`