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.

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

Hide reporters from public interface #5122

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

SimplyDanny
Copy link
Collaborator

Or is there a good reason to expose them?

@SimplyDanny SimplyDanny requested a review from jpsim July 15, 2023 13:36
@SwiftLintBot
Copy link

SwiftLintBot commented Jul 15, 2023

1 Warning
⚠️ This PR may need tests.
17 Messages
📖 Linting Aerial with this PR took 1.12s vs 1.13s on main (0% faster)
📖 Linting Alamofire with this PR took 1.45s vs 1.46s on main (0% faster)
📖 Linting Brave with this PR took 8.37s vs 8.37s on main (0% slower)
📖 Linting DuckDuckGo with this PR took 4.12s vs 4.14s on main (0% faster)
📖 Linting Firefox with this PR took 9.81s vs 9.83s on main (0% faster)
📖 Linting Kickstarter with this PR took 10.53s vs 10.53s on main (0% slower)
📖 Linting Moya with this PR took 0.59s vs 0.59s on main (0% slower)
📖 Linting NetNewsWire with this PR took 3.16s vs 3.16s on main (0% slower)
📖 Linting Nimble with this PR took 0.77s vs 0.77s on main (0% slower)
📖 Linting PocketCasts with this PR took 8.35s vs 8.32s on main (0% slower)
📖 Linting Quick with this PR took 0.38s vs 0.38s on main (0% slower)
📖 Linting Realm with this PR took 11.92s vs 11.87s on main (0% slower)
📖 Linting Sourcery with this PR took 2.38s vs 2.39s on main (0% faster)
📖 Linting Swift with this PR took 5.04s vs 5.05s on main (0% faster)
📖 Linting VLC with this PR took 1.41s vs 1.43s on main (1% faster)
📖 Linting Wire with this PR took 8.68s vs 8.67s on main (0% slower)
📖 Linting WordPress with this PR took 12.5s vs 12.51s on main (0% faster)

Generated by 🚫 Danger

@mildm8nnered
Copy link
Collaborator

So I have a use case where I want to use the Summary reporter

Or is there a good reason to expose them?

So I have a use case in #5041, where I'd like to use the Summary reporter as part of a configuration wizard configure command, to show the user what violations are currently present in their tree ...

@SimplyDanny
Copy link
Collaborator Author

So I have a use case in #5041, where I'd like to use the Summary reporter as part of a configuration wizard configure command, to show the user what violations are currently present in their tree ...

You are free to make some of them public again as needed. Most reporters don't need to be publicly visible, though. reporterFrom(identifier:) is the only interface that must be accessible. So having the implementations internal by default seems more logical.

@SimplyDanny SimplyDanny enabled auto-merge (squash) August 28, 2023 17:37
@SimplyDanny SimplyDanny merged commit 5544ce1 into realm:main Aug 28, 2023
@SimplyDanny SimplyDanny deleted the hide-reporters branch August 28, 2023 17:50
KS1019 pushed a commit to KS1019/SwiftLint that referenced this pull request Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants