Add inline comments support to the xcconfig parser

[dive]

Resolves #602

Short description 📝

Add support for inline comments in xcconfig files.

Solution 📦

Extend the existed regular expression to support xcconfig comments and use them as a full-stop condition.

Implementation 👩‍💻👨‍💻

XCConfig.swift regular expression (settingRegex) extended with a positive lookahead condition as the last statement. Previously, the expression handles the end of the line ('$') as a final grouping statement and now it parses up until the end of the line or up to the comment indication (//) with the (?=$|\\/\\/) group.

• Update XCConfigTests with failing scenarios
• Adjust the settingRegex NSRegularExpression to support comments
• Extend XCConfigTests with edge-cases

P.S. You can play with the updated regular expression here.

[codecov]

Codecov Report

Merging #604 (10e11f3) into main (4b14bb1) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #604   +/-   ##
=======================================
  Coverage   84.24%   84.25%           
=======================================
  Files         154      154           
  Lines        8672     8674    +2     
=======================================
+ Hits         7306     7308    +2     
  Misses       1366     1366           

Impacted Files	Coverage Δ
Sources/XcodeProj/Utils/XCConfig.swift	92.47% <ø> (ø)
Tests/XcodeProjTests/Utils/XCConfigTests.swift	97.50% <100.00%> (+0.06%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b14bb1...10e11f3. Read the comment docs.

[adellibovi]

Nice fix @dive!

[pepicrft]

Would you mind updating the changelog @dive ? We can merge afterward.

[fortmarek]

Nice! This probably will not catch another edge case where the setting is followed by multiline comment /* but I am not sure if that's something we want to account for

[dive]

Would you mind updating the changelog @dive ? We can merge afterward.

@pepibumur, added. Thanks!

Nice! This probably will not catch another edge case where the setting is followed by multiline comment /* but I am not sure if that's something we want to account for

@fortmarek, as far as I know, xcconfig does not support multiline comments. There is no official specification but Xcode ignores them for sure. The only additional edge-case I am aware of is NAME="https://example.com" case but even the current Xcode parser does not allow such entries in xcconfig.

[fortmarek]

Thanks @dive for the explanation, makes sense 👍