Moving logic in executable target to framework
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
Currently, there is a lot of functionality built into the executable target 'swiftlint'. This means that if you want to use SwiftLint as a framework, such as when building a plugin for Tuist, most of whats in the executable target needs to be duplicated.
Would a PR be welcome that moves most of the CLI functionality, other than the ArgumentParser commands, to either SwiftLintFramework or to another framework in between the two?
This would allow SwiftLint to be used as a framework much more easily and would have no outside impact on users of the swiftlint executable. It would either be added as an extra layer of public API to the SwiftLintFramework or as a 2nd framework that sits between the two.
I am happy to work on the PR, but wanted to check it was a change that was actually welcomed first.
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 examining the executable target 'swiftlint', the ArgumentParser commands, and SwiftLintFramework to map which CLI functionality is currently tied to the executable. Done means the shared functionality is available through a framework without duplicating it, while preserving the existing swiftlint executable behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- cli, developer-experience
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100