Substitution support in custom rules
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- [ x ] I've Updated SwiftLint to the latest version.
- [ x ] I've searched for existing GitHub issues.
Feature Request or Enhancement Proposal
I suggest supporting substitutions in custom rules to provide contextual warnings and errors.
Example of the rule with a substitution:
corner_radius_setter:
name: "CornerRadius setter"
regex: 'layer\.cornerRadius = (.+)'
message: "Use setCornerRadius($1) instead"
severity: warning
So for this line:
layer.cornerRadius = 34
We get the message:
Use setCornerRadius(34) instead
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 by locating SwiftLint's custom-rule configuration and message-generation entry points; the issue names custom rules and gives a YAML example but no files or tests. Trace how regex matches and warning messages are currently handled. Done means a capture such as 34 can appear in the warning as shown, with coverage for the substitution behavior.
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