FileHeaderConfiguration Request: Add a SWIFTLINT_CURRENT_PRODUCT placeholder
Open
Nobody has claimed this yet.
discussion
- 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
When using File Header rule, we have the SWIFTLINT_CURRENT_FILENAME placeholder to force the filename to be consistent with the header.
Therefore, the header can contains the Swift Package Name, specifically (since a single Swift Package can contains more than one product) the product.
Example:
# MyPackage/Sources/MyProduct/File.swift
//
// File.swift
// MyProduct
//
// Copyright 2023
//
would be a valid header for the rule:
file_header:
required_pattern: |
\/\/
\/\/ SWIFTLINT_CURRENT_FILENAME
\/\/ SWIFTLINT_CURRENT_PRODUCT
\/\/
\/\/ Copyright \d{4}
\/\/
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 File Header rule and trace how the existing SWIFTLINT_CURRENT_FILENAME placeholder is resolved. Determine how a Swift package product can be identified for a source file, then add SWIFTLINT_CURRENT_PRODUCT support and tests showing that the example header pattern is accepted with the product name.
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
- 35/100