Naming tweaks.

Author: ileitch

CHANGELOG.md

@@ -12,7 +12,7 @@
 
 - Fix guard-let shorthand syntax.
 - Fix accuracy of unused parameter analysis for overridden and protocol conforming functions.
-- Fix retaining buildFinalResult(_:) and buildLimitedAvailability(_:) result builder methods.
+- Fix retaining `buildFinalResult(_:)` and `buildLimitedAvailability(_:)` result builder methods.
 
 ## 2.10.1 (2022-11-20)
 

Sources/PeripheryKit/Analyzer/Analyzer.swift

@@ -52,7 +52,7 @@ public final class Analyzer {
 
         DeclarationMarker.self,
         RedundantProtocolMarker.self,
-        IfLetShorthandPropertyReferenceRetainer.self
+        LetShorthandPropertyReferenceRetainer.self
     ]
 
     private let graph: SourceGraph

Sources/PeripheryKit/Analyzer/Visitors/IfLetShorthandPropertyReferenceRetainer.swift renamed to Sources/PeripheryKit/Analyzer/Visitors/letShorthandPropertyReferenceRetainer.swift

@@ -1,7 +1,7 @@
 import Foundation
 
 /// Workaround for https://github.com/apple/swift/issues/61509.
-final class IfLetShorthandPropertyReferenceRetainer: SourceGraphVisitor {
+final class LetShorthandPropertyReferenceRetainer: SourceGraphVisitor {
     static func make(graph: SourceGraph) -> Self {
         return self.init(graph: graph)
     }
@@ -21,7 +21,7 @@ final class IfLetShorthandPropertyReferenceRetainer: SourceGraphVisitor {
         for property in properties {
             guard let propertyName = property.name,
                   let parent = property.parent,
-                  parent.declarations.contains(where: { $0.ifLetShorthandIdentifiers.contains(propertyName) })
+                  parent.declarations.contains(where: { $0.letShorthandIdentifiers.contains(propertyName) })
             else { continue }
             graph.markReachable(property)
         }

Sources/PeripheryKit/Indexer/Declaration.swift

@@ -175,7 +175,7 @@ public final class Declaration {
     public var commentCommands: Set<CommentCommand> = []
     public var references: Set<Reference> = []
     public var declaredType: String?
-    public var ifLetShorthandIdentifiers: Set<String> = []
+    public var letShorthandIdentifiers: Set<String> = []
 
     public var parent: Declaration?
     var related: Set<Reference> = []

Sources/PeripheryKit/Indexer/SwiftIndexer.swift

@@ -361,7 +361,7 @@ public final class SwiftIndexer {
                     decl.modifiers = Set(result.modifiers)
                     decl.commentCommands = Set(result.commentCommands)
                     decl.declaredType = result.variableType
-                    decl.ifLetShorthandIdentifiers = result.ifLetShorthandIdentifiers
+                    decl.letShorthandIdentifiers = result.letShorthandIdentifiers
 
                     for ref in decl.references.union(decl.related) {
                         if result.inheritedTypeLocations.contains(ref.location) {

Sources/PeripheryKit/Syntax/DeclarationVisitor.swift

@@ -19,13 +19,13 @@ final class DeclarationVisitor: PeripherySyntaxVisitor {
         inheritedTypeLocations: Set<SourceLocation>,
         genericParameterLocations: Set<SourceLocation>,
         genericConformanceRequirementLocations: Set<SourceLocation>,
-        ifLetShorthandIdentifiers: Set<String>
+        letShorthandIdentifiers: Set<String>
     )
 
     private let sourceLocationBuilder: SourceLocationBuilder
     private let typeSyntaxInspector: TypeSyntaxInspector
     private(set) var results: [Result] = []
-    private var ifLetShorthandIdentifiers: Set<String> = []
+    private var letShorthandIdentifiers: Set<String> = []
     private var functionDeclStackDepth = 0
 
     var resultsByLocation: [SourceLocation: Result] {
@@ -267,7 +267,7 @@ final class DeclarationVisitor: PeripherySyntaxVisitor {
               let parentStmt = node.parent?.parent?.parent,
               (parentStmt.is(IfStmtSyntax.self) || parentStmt.is(GuardStmtSyntax.self))
         else { return }
-        ifLetShorthandIdentifiers.insert(identifier.text)
+        letShorthandIdentifiers.insert(identifier.text)
     }
 
     // MARK: - Private
@@ -290,13 +290,13 @@ final class DeclarationVisitor: PeripherySyntaxVisitor {
             AttributeSyntax($0)?.attributeName.text ?? CustomAttributeSyntax($0)?.attributeName.firstToken?.text
         } ?? []
         let location = sourceLocationBuilder.location(at: position)
-        var ifLetShorthandIdentifiers = Set<String>()
+        var letShorthandIdentifiers = Set<String>()
 
-        // Only associate if-let shorthand identifiers in nested functions with the top-most
+        // Only associate let shorthand identifiers in nested functions with the top-most
         // function.
         if functionDeclStackDepth == 0 {
-            ifLetShorthandIdentifiers = self.ifLetShorthandIdentifiers
-            self.ifLetShorthandIdentifiers.removeAll()
+            letShorthandIdentifiers = self.letShorthandIdentifiers
+            self.letShorthandIdentifiers.removeAll()
         }
 
         results.append((
@@ -312,7 +312,7 @@ final class DeclarationVisitor: PeripherySyntaxVisitor {
             typeLocations(for: inheritanceClause),
             typeLocations(for: genericParameterClause),
             typeLocations(for: genericWhereClause),
-            ifLetShorthandIdentifiers
+            letShorthandIdentifiers
         ))
     }
 

Tests/Fixtures/RetentionFixtures/testIfLetShorthandSyntax.swift renamed to Tests/Fixtures/RetentionFixtures/testLetShorthandSyntax.swift

@@ -30,11 +30,11 @@ class FixtureClass130 {
         Array(components.joined())
     }
 
-    static func buildFinalResult(_ component: FixtureClass130.Component) -> Component {
+    static func buildFinalResult(_ component: Component) -> Component {
         component
     }
 
-    static func buildLimitedAvailability(_ component: FixtureClass130.Component) -> Component {
+    static func buildLimitedAvailability(_ component: Component) -> Component {
         component
     }
 }

Tests/Fixtures/RetentionFixtures/testRetainsResultBuilderMethods.swift

@@ -1001,7 +1001,7 @@ final class RetentionTest: SourceGraphTestCase {
         }
     }
 
-    func testIfLetShorthandSyntax() {
+    func testLetShorthandSyntax() {
         analyze(retainPublic: true) {
             assertReferenced(.class("FixtureClass117")) {
                 self.assertReferenced(.varInstance("simpleProperty"))
@@ -1015,7 +1015,7 @@ final class RetentionTest: SourceGraphTestCase {
                 self.assertReferenced(.varInstance("propertyReferencedFromPropertyAccessor"))
             }
 
-            // This property should be referenced, but the if-let shorthand workaround doesn't
+            // This property should be referenced, but the let shorthand workaround doesn't
             // handle properties at global (file) scope. This will remain broken until the
             // issue is resolved in Swift: https://github.com/apple/swift/issues/61509.
             self.assertNotReferenced(.varGlobal("fixtureClass117StaticProperty"))