wip

Sources/CliDoc/BaseNodes/HStack.swift

@@ -17,6 +17,7 @@ public struct HStack: TextNode {
 
   @inlinable
   public var body: some TextNode {
-    content.map { $0.render() }.joined(separator: separator.render())
+    content.removingEmptys()
+      .joined(separator: separator.render())
   }
 }

Sources/CliDoc/BaseNodes/VStack.swift

@@ -17,6 +17,7 @@ public struct VStack: TextNode {
 
   @inlinable
   public var body: some TextNode {
-    content.map { $0.render() }.joined(separator: separator.render())
+    content.removingEmptys()
+      .joined(separator: separator.render())
   }
 }

Sources/CliDoc/Modifiers/ExamplesStyle.swift

@@ -1,105 +0,0 @@
-import Rainbow
-
-public extension ExampleSection {
-
-  func style<S: ExampleSectionStyle>(_ style: S) -> some TextNode {
-    style.render(content: .init(
-      header: header,
-      label: label,
-      examples: examples
-    ))
-  }
-
-  func exampleStyle<S: ExampleStyle>(_ style: S) -> some TextNode {
-    DefaultExamplesStyle(exampleStyle: style).render(content: .init(
-      header: header,
-      label: label,
-      examples: examples
-    ))
-  }
-}
-
-extension Array where Element == ExampleSection.Example {
-  func exampleStyle<S: ExampleStyle>(_ style: S) -> some TextNode {
-    style.render(content: .init(examples: self))
-  }
-}
-
-public struct ExampleSectionConfiguration {
-  @usableFromInline
-  let header: any TextNode
-
-  @usableFromInline
-  let label: any TextNode
-
-  @usableFromInline
-  let examples: [ExampleSection.Example]
-
-  @usableFromInline
-  init(header: any TextNode, label: any TextNode, examples: [ExampleSection.Example]) {
-    self.header = header
-    self.label = label
-    self.examples = examples
-  }
-}
-
-public struct ExampleConfiguration {
-  @usableFromInline
-  let examples: [ExampleSection.Example]
-
-  @usableFromInline
-  init(examples: [ExampleSection.Example]) {
-    self.examples = examples
-  }
-}
-
-public protocol ExampleSectionStyle: NodeModifier where Content == ExampleSectionConfiguration {}
-public protocol ExampleStyle: NodeModifier where Content == ExampleConfiguration {}
-
-public extension ExampleSectionStyle where Self == DefaultExamplesStyle {
-  static func `default`(exampleStyle: any ExampleStyle = .default) -> Self {
-    DefaultExamplesStyle(exampleStyle: exampleStyle)
-  }
-}
-
-public extension ExampleStyle where Self == DefaultExampleStyle {
-  static var `default`: Self {
-    DefaultExampleStyle()
-  }
-}
-
-public struct DefaultExamplesStyle: ExampleSectionStyle {
-
-  @usableFromInline
-  let exampleStyle: any ExampleStyle
-
-  @inlinable
-  public init(exampleStyle: any ExampleStyle = .default) {
-    self.exampleStyle = exampleStyle
-  }
-
-  @inlinable
-  public func render(content: ExampleSectionConfiguration) -> some TextNode {
-    VStack(spacing: 2) {
-      HStack {
-        content.header
-        content.label
-      }
-      exampleStyle.render(content: .init(examples: content.examples))
-    }
-  }
-}
-
-public struct DefaultExampleStyle: ExampleStyle {
-
-  public func render(content: ExampleConfiguration) -> some TextNode {
-    VStack(spacing: 2) {
-      content.examples.map { example in
-        VStack {
-          Label(example.label.green.bold)
-          ShellCommand { example.example }.style(.default)
-        }
-      }
-    }
-  }
-}

Sources/CliDoc/Modifiers/SectionStyle.swift

@@ -31,7 +31,7 @@ public struct DefaultSectionStyle: SectionStyle {
     VStack {
       content.header
       content.content
-      content.footer.textStyle(.italic)
+      content.footer
     }
   }
 }

Sources/CliDoc/Nodes/ExampleSection.swift

@@ -4,23 +4,32 @@ public struct ExampleSection<Header: TextNode, Label: TextNode>: TextNode {
   public typealias Example = (label: String, example: String)
 
   @usableFromInline
-  let examples: [Example]
-
-  @usableFromInline
-  let header: Header
-
-  @usableFromInline
-  let label: Label
+  let configuration: ExampleSectionConfiguration
 
   @inlinable
   public init(
     examples: [Example],
-    @TextBuilder header: () -> Header,
+    @TextBuilder title: () -> Header,
     @TextBuilder label: () -> Label
   ) {
-    self.examples = examples
-    self.header = header()
-    self.label = label()
+    self.configuration = .init(
+      title: title(),
+      label: label(),
+      examples: examples
+    )
+  }
+
+  @inlinable
+  public init(
+    _ title: @autoclosure () -> Header,
+    label: @autoclosure () -> Label,
+    examples: [Example]
+  ) {
+    self.init(
+      examples: examples,
+      title: title,
+      label: label
+    )
   }
 
   @inlinable
@@ -29,23 +38,105 @@ public struct ExampleSection<Header: TextNode, Label: TextNode>: TextNode {
   }
 }
 
-public extension ExampleSection where Header == String, Label == String {
-  @inlinable
-  init(
-    header: String = "Examples:".yellow.bold,
-    label: String = "Some common usage examples.",
-    examples: [Example]
-  ) {
-    self.init(examples: examples) { header } label: { label }
-  }
+/// The type-erased configuration of an ``ExampleSection``
+public struct ExampleSectionConfiguration {
+  @usableFromInline
+  let title: any TextNode
 
-  @inlinable
-  init(
-    header: String = "Examples:".yellow.bold,
-    label: String = "Some common usage examples.",
-    examples: Example...
-  ) {
-    self.init(header: header, label: label, examples: examples)
-  }
+  @usableFromInline
+  let label: any TextNode
 
+  @usableFromInline
+  let examples: [ExampleSection.Example]
+
+  @usableFromInline
+  init(title: any TextNode, label: any TextNode, examples: [ExampleSection.Example]) {
+    self.title = title
+    self.label = label
+    self.examples = examples
+  }
+}
+
+// MARK: - Style
+
+public extension ExampleSection {
+
+  func style<S: ExampleSectionStyle>(_ style: S) -> some TextNode {
+    style.render(content: configuration)
+  }
+
+  func exampleStyle<S: ExampleStyle>(_ style: S) -> some TextNode {
+    DefaultExamplesStyle(exampleStyle: style).render(content: configuration)
+  }
+}
+
+extension Array where Element == ExampleSection.Example {
+  func exampleStyle<S: ExampleStyle>(_ style: S) -> some TextNode {
+    style.render(content: .init(examples: self))
+  }
+}
+
+public struct ExampleConfiguration {
+  @usableFromInline
+  let examples: [ExampleSection.Example]
+
+  @usableFromInline
+  init(examples: [ExampleSection.Example]) {
+    self.examples = examples
+  }
+}
+
+public protocol ExampleSectionStyle: NodeModifier where Content == ExampleSectionConfiguration {}
+public protocol ExampleStyle: NodeModifier where Content == ExampleConfiguration {}
+
+public extension ExampleSectionStyle where Self == DefaultExamplesStyle {
+  static func `default`(exampleStyle: any ExampleStyle = .default) -> Self {
+    DefaultExamplesStyle(exampleStyle: exampleStyle)
+  }
+}
+
+public extension ExampleStyle where Self == DefaultExampleStyle {
+  static var `default`: Self {
+    DefaultExampleStyle()
+  }
+}
+
+public struct DefaultExamplesStyle: ExampleSectionStyle {
+
+  @usableFromInline
+  let exampleStyle: any ExampleStyle
+
+  @inlinable
+  public init(exampleStyle: any ExampleStyle = .default) {
+    self.exampleStyle = exampleStyle
+  }
+
+  @inlinable
+  public func render(content: ExampleSectionConfiguration) -> some TextNode {
+    VStack(spacing: 2) {
+      HStack {
+        content.title
+          .color(.yellow)
+          .textStyle(.bold)
+
+        content.label
+          .textStyle(.italic)
+      }
+      exampleStyle.render(content: .init(examples: content.examples))
+    }
+  }
+}
+
+public struct DefaultExampleStyle: ExampleStyle {
+
+  public func render(content: ExampleConfiguration) -> some TextNode {
+    VStack(spacing: 2) {
+      content.examples.map { example in
+        VStack {
+          Label(example.label.green.bold)
+          ShellCommand { example.example }.style(.default)
+        }
+      }
+    }
+  }
 }

Sources/CliDoc/Utils.swift

@@ -19,3 +19,18 @@ func seperator(_ separator: String, count: Int) -> any TextNode {
   }
   return output
 }
+
+extension Array where Element == (any TextNode) {
+
+  @usableFromInline
+  func removingEmptys() -> [String] {
+    compactMap { node in
+      let string = node.render()
+      if string == "" {
+        return nil
+      }
+      return string
+    }
+  }
+
+}