realm / realm/SwiftLint

[Rule Request] Don't allow @testable imports outside of tests

Open
#3,957 3 comments 0 reactions 0 assignees View on GitHub

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
New rule request
  1. 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/QuickSpec subclass?
  1. Provide several examples of what would and wouldn't trigger violations.
//ok
@testable import Foo
import XCTest

// not ok
@testable import Foo
  1. 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])
  1. 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.