Fix inline ignore comment not working on properties (#1025)

Author: ileitch

CHANGELOG.md

@@ -13,6 +13,7 @@
 
 ##### Bug Fixes
 
+- Fix inline ignore comment not working on properties.
 - Fix false positive when a constrained protocol extension provides a default implementation that satisfies a requirement of the constraining protocol.
 - Fix indexing of xib/storyboard files in SPM projects.
 - Fix types conforming to App Intents protocols being reported as unused.

Sources/SyntaxAnalysis/DeclarationSyntaxVisitor.swift

@@ -528,7 +528,7 @@ private extension SyntaxProtocol {
     /// Foo {} // periphery:ignore
     /// ```
     var commentCommandTrivia: Trivia {
-        var commandTrivia = leadingTrivia
+        var commandTrivia = leadingTrivia.merging(trailingTrivia)
 
         if let hasMemberBlock = self as? HasMemberBlock {
             commandTrivia = commandTrivia
@@ -542,6 +542,12 @@ private extension SyntaxProtocol {
                 .merging(body.rightBrace.trailingTrivia)
         }
 
+        if let hasAccessorBlock = self as? HasAccessorBlock, let accessorBlock = hasAccessorBlock.accessorBlock {
+            commandTrivia = commandTrivia
+                .merging(accessorBlock.leftBrace.trailingTrivia)
+                .merging(accessorBlock.rightBrace.trailingTrivia)
+        }
+
         return commandTrivia
     }
 }
@@ -566,3 +572,14 @@ private protocol HasCodeBody {
 extension FunctionDeclSyntax: HasCodeBody {}
 extension InitializerDeclSyntax: HasCodeBody {}
 extension DeinitializerDeclSyntax: HasCodeBody {}
+
+/// Identifies types with an AccessorBlockSyntax child
+private protocol HasAccessorBlock {
+    var accessorBlock: AccessorBlockSyntax? { get }
+}
+
+extension VariableDeclSyntax: HasAccessorBlock {
+    var accessorBlock: AccessorBlockSyntax? {
+        bindings.first?.accessorBlock
+    }
+}

Tests/Fixtures/Sources/RetentionFixtures/testIgnoreComments.swift

@@ -113,3 +113,16 @@ public class Fixture308Class {
 public class Fixture309Class { // periphery:ignore
     public let reference = Fixture308Class()
 }
+
+// Test inline ignore comments on properties
+public class Fixture310Class {
+    var simplePropertyInlineIgnored: Int = 0 // periphery:ignore
+    var computedPropertyInlineIgnored: Int { 0 } // periphery:ignore
+    var computedPropertyWithOpenBraceIgnore: Int { // periphery:ignore
+        0
+    }
+}
+
+public protocol Fixture311Protocol {
+    var protocolPropertyInlineIgnored: String { get } // periphery:ignore
+}

Tests/PeripheryTests/RetentionTest.swift

@@ -1113,6 +1113,16 @@ final class RetentionTest: FixtureSourceGraphTestCase {
             assertReferenced(.class("Fixture205"))
             assertReferenced(.protocol("Fixture205Protocol"))
             assertNotRedundantProtocol("Fixture205Protocol")
+
+            // Inline ignore comments on properties (issue #941)
+            assertReferenced(.class("Fixture310Class")) {
+                self.assertReferenced(.varInstance("simplePropertyInlineIgnored"))
+                self.assertReferenced(.varInstance("computedPropertyInlineIgnored"))
+                self.assertReferenced(.varInstance("computedPropertyWithOpenBraceIgnore"))
+            }
+            assertReferenced(.protocol("Fixture311Protocol")) {
+                self.assertReferenced(.varInstance("protocolPropertyInlineIgnored"))
+            }
         }
 
         // inline comment command tests