Rule Request: no-print
Nobody has claimed this yet.
- 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.
Leftover logs in production can cause security breaches in any app. Also, logging to the console has performance drawbacks on iOS.
- Provide several examples of what would and wouldn't trigger violations.
Any calls to
debugPrintordumpwould trigger a warning violation.
- Should the rule be configurable, if so what parameters should be configurable?
I cannot think of anything that should be configurable at this moment.
- 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.
Considering how it could pose as a security violation, I do believe
no-printshould be enabled by default.
If this RFC is approved, I'm more than happy to work on it and open a PR.
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 repository's README.md opt-in-rules guidance and review how existing SwiftLint rules are organized. Define completion around detecting calls to print, debugPrint, and dump without configuration, then add coverage for triggering and non-triggering examples in the rule's tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100