Rename startDebugLayout() to inspectLayout() and debugLayout() to layoutStep()

Author: ole

DemoApp/ContentView.swift

@@ -3,42 +3,45 @@ import SwiftUI
 
 struct ContentView: View {
     var body: some View {
-        Inspector {
-            /// The view tree whose layout you want to inspect. Add `.debugLayout()` calls at
-            /// each point where you want to inspect the layout algorithm, i.e. what sizes are
-            /// being proposed and returned. We call these **inspection points**.
-            hStackExample
+        /// The view tree whose layout you want to inspect. Add `.layoutStep()`
+        /// calls at each point where you want to inspect the layout algorithm,
+        /// i.e. what sizes are being proposed and returned. We call these
+        ///  **inspection points**.
+        VStack {
+            Inspector {
+                hStackExample
+            }
         }
     }
 
     var paddingExample: some View {
         Text("Hello world")
-            .debugLayout("Text")
+            .layoutStep("Text")
             .padding(10)
-            .debugLayout("padding")
+            .layoutStep("padding")
             .border(Color.green)
-            .debugLayout("border")
+            .layoutStep("border")
     }
 
     var hStackExample: some View {
         HStack(spacing: 10) {
             Rectangle().fill(.green)
-                .debugLayout("green")
+                .layoutStep("green")
             Text("Hello world")
-                .debugLayout("Text")
+                .layoutStep("Text")
             Rectangle().fill(.yellow)
-                .debugLayout("yellow")
+                .layoutStep("yellow")
         }
-        .debugLayout("HStack")
+        .layoutStep("HStack")
     }
 
     var fixedSizeExample: some View {
           Text("Lorem ipsum dolor sit amet")
-              .debugLayout("Text")
+              .layoutStep("Text")
               .fixedSize()
-              .debugLayout("fixedSize")
+              .layoutStep("fixedSize")
               .frame(width: 100)
-              .debugLayout("frame")
+              .layoutStep("frame")
               .border(Color.green)
     }
 }
@@ -59,7 +62,7 @@ struct Inspector<Subject: View>: View {
         VStack {
             VStack {
                 subject
-                    .startDebugLayout(selection: selectedView)
+                    .inspectLayout(selection: selectedView)
                     .id(generation)
                     .frame(width: roundedWidth, height: roundedHeight)
                     .overlay {

README.md

@@ -40,18 +40,18 @@ Layout Inspector consists of:
 
 ## Requirements
 
-iOS 16.0 or macOS 13.0 (requires the `Layout` protocol).
+iOS 16.0 or macOS 13.0 (because it requires the `Layout` protocol).
 
 ## Instructions
 
 1.  `import LayoutInspector`
-    
-2.  Add `.debugLayout()` at each point in a view tree where you want to inspect
-    the layout algorithm (what sizes are being proposed and returned).
-    
-3.  At the top of the view tree you want to inspect, add `.startDebugLayout()`.
 
-See the README of the demo app for a complete example.
+2.  At the top of the view tree you want to inspect, insert `.inspectLayout()`.
+    
+3.  Insert `.layoutStep("View label")` at each point in a view tree where you
+    want to inspect the layout algorithm (what sizes are being proposed and
+    returned). This is necessary to inject the helper "views" that observe the
+    layout process.
 
 ## Acknowledgements
 

Sources/LayoutInspector/DebugLayout.swift

@@ -2,10 +2,8 @@ import SwiftUI
 
 @available(macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0, *)
 extension View {
-    /// Start debugging the layout algorithm for this subtree.
-    ///
-    /// This clears the debug layout log.
-    public func startDebugLayout(selection: String? = nil) -> some View {
+    /// Inspect the layout for this subtree.
+    public func inspectLayout(selection: String? = nil) -> some View {
         ClearDebugLayoutLog {
             self
         }
@@ -14,7 +12,7 @@ extension View {
 
     /// Monitor the layout proposals and responses for this view and add them
     /// to the log.
-    public func debugLayout(
+    public func layoutStep(
         _ label: String,
         file: StaticString = #fileID,
         line: UInt = #line

Sources/LayoutInspector/DebugLayoutImpl.swift

@@ -136,7 +136,7 @@ public final class LogStore: ObservableObject {
     func registerViewLabelAndWarnIfNotUnique(_ label: String, file: StaticString, line: UInt) {
         DispatchQueue.main.async {
             if self.viewLabels.contains(label) {
-                let message: StaticString = "Duplicate view label '%s' detected. Use unique labels in debugLayout() calls"
+                let message: StaticString = "Duplicate view label '%s' detected. Use unique labels in layoutStep() calls"
                 runtimeWarning(message, [label], file: file, line: line)
             }
             self.viewLabels.insert(label)