[Rule Request] Don't allow @testable imports outside of tests
Open
Nobody has claimed this yet.
rule-request
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- Updated SwiftLint to the latest version
- I searched for existing GitHub issues
New rule request
- Why should this rule be added? Share links to existing discussion about what
the community thinks about this.
@testable import is meant to be used in unit tests target only. While it's hard to tell whether we're in an unit test target, we could use some heuristics:
- Is this file importing
XCTest/Quick/Nimble? or - Is there a
XCTestCase/QuickSpecsubclass?
- Provide several examples of what would and wouldn't trigger violations.
//ok
@testable import Foo
import XCTest
// not ok
@testable import Foo
- Should the rule be configurable, if so what parameters should be configurable?5.
- Severity
- Test frameworks - used to configure the search for imports (default:
[XCTest, Quick, Nimble]) - Test subclass (default:
[XCTestCase, QuickSpec])
- Should the rule be opt-in or enabled by default? Why?
See README.md for guidelines on when to mark a rule as opt-in.
Opt-in. By its nature, this rule will have false positives.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the issue's proposed heuristics and the README.md opt-in-rules guidance. Define the rule around @testable imports, XCTest/Quick/Nimble imports, and XCTestCase/QuickSpec subclasses, then verify the provided allowed and violating examples and the requested configuration options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- testing-qa, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100