Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust interface template comments #905

Merged
merged 1 commit into from
Mar 3, 2025
Merged

Adjust interface template comments #905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions Sources/NodesGenerator/Resources/Stencils/Interface-SwiftUI.stencil
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,17 @@ import {{ import }}
{% endfor %}
{% endif %}

// This file defines the protocols and types in the interface requiring public ACL for use in another module.
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/
{% if node_name != "App" %}

// MARK: - Listener

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol {{ node_name }}Listener: AnyObject {}
{% endif %}

// MARK: - Flow

/// @mockable
@MainActor
{% if plugin_list_name %}
Expand All @@ -27,8 +25,6 @@ internal protocol {{ node_name }}Flow: {{ plugin_list_name }}Flow {}
internal protocol {{ node_name }}Flow: {{ view_controllable_flow_type }} {}
{% endif %}

// MARK: - Builder

{% if is_periphery_comment_enabled %}
// periphery:ignore
{% endif %}
Expand Down
10 changes: 3 additions & 7 deletions ...__Snapshots__/StencilRendererTests/testRenderNode.Interface-AppKitSwiftUI-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
//<fileHeader>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <viewControllableFlowType> {}

// MARK: - Builder

/// @mockable
@MainActor
internal protocol <nodeName>Builder: AnyObject {
Expand Down
10 changes: 3 additions & 7 deletions ...__Snapshots__/StencilRendererTests/testRenderNode.Interface-AppKitSwiftUI-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@

import <interfaceImport>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions ...__Snapshots__/StencilRendererTests/testRenderNode.Interface-AppKitSwiftUI-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,19 @@
import <interfaceImport1>
import <interfaceImport2>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions .../__Snapshots__/StencilRendererTests/testRenderNode.Interface-UIKitSwiftUI-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
//<fileHeader>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <viewControllableFlowType> {}

// MARK: - Builder

/// @mockable
@MainActor
internal protocol <nodeName>Builder: AnyObject {
Expand Down
10 changes: 3 additions & 7 deletions .../__Snapshots__/StencilRendererTests/testRenderNode.Interface-UIKitSwiftUI-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@

import <interfaceImport>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions .../__Snapshots__/StencilRendererTests/testRenderNode.Interface-UIKitSwiftUI-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,19 @@
import <interfaceImport1>
import <interfaceImport2>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions ...__/StencilRendererTests/testRenderNode_withPlugin.Interface-AppKitSwiftUI-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
//<fileHeader>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <viewControllableFlowType> {}

// MARK: - Builder

/// @mockable
@MainActor
internal protocol <nodeName>Builder: AnyObject {
Expand Down
10 changes: 3 additions & 7 deletions ...__/StencilRendererTests/testRenderNode_withPlugin.Interface-AppKitSwiftUI-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@

import <interfaceImport>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions ...__/StencilRendererTests/testRenderNode_withPlugin.Interface-AppKitSwiftUI-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,19 @@
import <interfaceImport1>
import <interfaceImport2>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions ...s__/StencilRendererTests/testRenderNode_withPlugin.Interface-UIKitSwiftUI-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
//<fileHeader>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <viewControllableFlowType> {}

// MARK: - Builder

/// @mockable
@MainActor
internal protocol <nodeName>Builder: AnyObject {
Expand Down
10 changes: 3 additions & 7 deletions ...s__/StencilRendererTests/testRenderNode_withPlugin.Interface-UIKitSwiftUI-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@

import <interfaceImport>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions ...s__/StencilRendererTests/testRenderNode_withPlugin.Interface-UIKitSwiftUI-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,19 @@
import <interfaceImport1>
import <interfaceImport2>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <pluginListName>Flow {}

// MARK: - Builder

// periphery:ignore
/// @mockable
@MainActor
Expand Down
10 changes: 3 additions & 7 deletions ...ilRendererTests/testRenderNode_withPluginAndTests.Interface-AppKitSwiftUI-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
//<fileHeader>

// This file defines the protocols and types in the interface requiring public ACL for use in another module.

// MARK: - Listener
/*
This file defines the protocols and types in the interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <nodeName>Listener: AnyObject {}

// MARK: - Flow

/// @mockable
@MainActor
internal protocol <nodeName>Flow: <viewControllableFlowType> {}

// MARK: - Builder

/// @mockable
@MainActor
internal protocol <nodeName>Builder: AnyObject {
Expand Down
Loading