realm / realm/SwiftLint

Rule Request: no-print

Open
#2,484 6 comments 15 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.

Leftover logs in production can cause security breaches in any app. Also, logging to the console has performance drawbacks on iOS.

  1. Provide several examples of what would and wouldn't trigger violations.

Any calls to print, debugPrint or dump would trigger a warning violation.

  1. Should the rule be configurable, if so what parameters should be configurable?

I cannot think of anything that should be configurable at this moment.

  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.

Considering how it could pose as a security violation, I do believe no-print should be enabled by default.

If this RFC is approved, I'm more than happy to work on it and open a PR.

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 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.