Fix globstar expansion logic to prevent infinite loop when file path contains **

[kyounh12]

Short description 📝

This PR fixes the crash happens when a Swift Package with source file paths containing ** (ex. **(_:_:)) is added to Tuist/Package.swift.

How to test the changes locally 🧐

It can be easily reproduced by adding BigDecimal Swift Package in Tuist/Package.swift

.package(url: "https://github.com/mgriebling/BigDecimal", exact: "2.2.3")

and then run tuist install tuist generate.

It will stuck in the line below and eventually finishes with a non-zero exit code.

Loading and constructing the graph
It might take a while if the cache is empty

The package contains a file with path Sources/BigDecimal/BigDecimal.docc/BigDecimal.doccarchive/documentation/bigdecimal/bigdecimal/**(_:_:)/index.html

Contributor checklist ✅

• The code has been linted using run mise run lint:fix
• The change is tested via unit testing or acceptance testing, or both
• The title of the PR is formulated in a way that is usable as a changelog entry
• In case the PR introduces changes that affect users, the documentation has been updated

Reviewer checklist ✅

• The code architecture and patterns are consistent with the rest of the codebase
• Reviewer has checked that, if needed, the PR includes the label changelog:added, changelog:fixed, or changelog:changed, and the title is usable as a changelog entry

[fortmarek]

I'm not sure how I feel about this. That's a lot of code in a foundational utility for a case that's more of a misconfiguration on the package side.

I'd rather consider two alternatives:

• Investigate why this file is being globbed in the first place when it should be considered a regular file returned from the original Sources glob
• Strip .doccarchive from the generated project – it doesn't make sense to include the individual files in the .doccarchive. That's actually how vanilla SPM behaves, so we can align with that instead:
  

[kyounh12]

@fortmarek I agree that .doccarchive should be stripped from the generated project and it may feel like too much code for a little utility function.
However, I still believe wrong interpretation of globstar may cause other problems in the future.

So how about resetting this branch to 00f32ab and open another PR for stripping .doccarchive from the project?

[kyounh12]

• Investigate why this file is being globbed in the first place when it should be considered a regular file returned from the original Sources glob

When expanding a globstar, it loops through subpaths and filter paths which is a directory by calling FileManager.isDirectory(path: String) function.

The function calls FileManager.fileExists(atPath path: String, isDirectory: UnsafeMutablePointer<ObjCBool>?) function internally and this fileExists function considers .doccarchive file as a directory.

This causes the program to continue to search through subpaths under a .doccarchive bundle.

[kyounh12]

• Strip .doccarchive from the generated project – it doesn't make sense to include the individual files in the .doccarchive. That's actually how vanilla SPM behaves, so we can align with that instead:

Seems like Xcode is already doing this for us if the project is generated correctly.