Rule Request: [os_log_debugonly] os_log should be wrapped with #if DEBUG
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
This rule would help developers not ship os_log calls in production code.
The violation would be triggered only if there is no open "#if DEBUG" directive preceding the call to os_log method.
I can't think of anything configurable for this rule.
The rule should be enabled by default, because it would get us all cleaner production code.
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
No files or tests are named. Start by locating SwiftLint’s existing rule implementations and their tests, then verify behavior for os_log calls with and without an open #if DEBUG directive; done means the rule is enabled by default and does not report calls inside that directive.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100