Add syntax to swiftlint_version to allow for specifying minimum and maximum versions #5694

alex-taffe · 2024-07-24T15:32:06Z

Currently, the configuration supports a swiftlint_version option. This option does not work for our workflow because we have many branches that may not be up to date with main/master. However, there are breaking changes that occur in SwiftLint, such as redundant_optional_initialization changing between 0.53.0 and 0.55.1, causing our team to not have consistency in their linting.

This adds new syntax to swiftlint_version that will compare to the current version installed and throw a warning/error if the installed version does not match the pattern the user specified

warning: Currently running SwiftLint 0.55.1 but configuration specified minimum version 0.55.3.

The syntax is as follows:

swiftlint_version: 0.54.0
swiftlint_version: ">0.54.0"
swiftlint_version: ">=0.54.0"
swiftlint_version: "<0.54.0"
swiftlint_version: "<=0.54.0"

SwiftLintBot · 2024-07-24T15:38:48Z

	1 Error
🚫	Could not build branch

	1 Warning
⚠️	This PR may need tests.

Generated by 🚫 Danger

alex-taffe · 2024-07-31T01:31:08Z

@SimplyDanny @mildm8nnered if you could take a look at this when you get a chance, thanks!

SimplyDanny · 2024-07-31T20:36:13Z

I see where you are coming from and why this would help, yet I was wondering whether a new separate key is really the way to go. The list is continuously growing and there is the problem of conflicting options. What about minimum_swiftlint_version: 0.54.0 and swiftlint_version: 0.53.0 for example? So there should probably be some consistency checks.

What I was thinking about is an extension of swiftlint_version in a way that it supports both fixed versions and a range of version given a minimum version. Something like the syntax swiftlint_version: >=0.54.0 could be conceivable. What's your opinion on that?

alex-taffe · 2024-07-31T20:47:37Z

Yeah I think I actually like that better, what're your thoughts on syntax? I kinda like Dart's. Traditional and caret. Then if we can't parse, just throw a fatal error.

Plus '>=1.2.3 <2.0.0' for inclusive

alex-taffe · 2024-07-31T20:51:11Z

Also what's the minimum version of macOS that SwiftLint supports? Would love to use new SwiftRegex but it's macOS 13 or newer only

SimplyDanny · 2024-07-31T21:13:02Z

Also what's the minimum version of macOS that SwiftLint supports? Would love to use new SwiftRegex but it's macOS 13 or newer only

SwiftLint still supports macOS 12. We'd need good reasons to change that. While I fancy as well with SwiftRegex, it's not enough reason to change the minimum deployment version. But that might change when macOS 15 is out.

About the syntax: I personally don't like the caret style so much. Only the three variants

0.54.0
>0.54.0
>=0.54.0

seem to be enough. There is no good reason for <0.54.0 or <=0.54.0, is there?

alex-taffe · 2024-07-31T21:34:08Z

In practice I’m guessing the less than or inclusive versions wouldn’t actually be used much (I doubt we ever will), but doesn’t seem like that much more work so might as well just do it while I’m in there. I’m fine with omitting caret syntax

SimplyDanny · 2024-07-31T21:40:27Z

In your implementation it could be helpful to know that Version objects are Comparable. 😉

alex-taffe · 2024-08-01T15:12:12Z

@SimplyDanny updated

SimplyDanny

Good starting point! Please also add some tests for all the cases.

CHANGELOG.md