[SR-13566] SPM's swift tools version specification requires exactly 1 single space character after "//"

[WowbaggersLiquidLunch]

Previous ID	SR-13566
Radar	None
Original Reporter	@WowbaggersLiquidLunch
Type	Bug
Status	Resolved
Resolution	Done

Additional Detail from JIRA

Votes	0
Component/s	Package Manager
Labels	Bug
Assignee	@WowbaggersLiquidLunch
Priority	Medium

md5: 95510fb6c4f0933086d339be5d484ac3

Issue Description:

This bug is about the first line in every Package.swift, e.g. // swift-tools-version:5.3.

Currently it only accept a single space character between "//" and "swift-tools-version:5.3". It should allow any number of any horizontal whitespace characters.

[WowbaggersLiquidLunch]

The code responsible for parsing this line is located at line 181 of swift-package-manager/Sources/PackageLoading/ToolsVersionLoader.swift, copied below:

// The regex to match swift tools version specification:
// * It should start with `//` followed by any amount of whitespace.
// * Following that it should contain the case insensitive string `swift-tools-version:`.
// * The text between the above string and `;` or string end becomes the tools version specifier.
static let regex = try! NSRegularExpression(
    pattern: "^// swift-tools-version:(.*?)(?:;.*|$)",
    options: [.caseInsensitive])

The regex intends to match "any amount of whitespace followed by //" (according to the comments in the code snippet above), but in its implementation, it matches only 1 space character.

This can be easily fixed, but I want to use this bug report to ask if it was a conscious design choice to allow only 1 space character, and shouldn't be changed.

[WowbaggersLiquidLunch]

Opened pull request #2937

[WowbaggersLiquidLunch]

resolved by apple/swift-package-manager#2937