GetMatchingFiles() Return Type

[WalkerCodeRanger]

The GlobbingExtensions.GetMatchingFiles(ICakeContext, IEnumerable<FilePath>) method returns IEnumerable<IFile> this is inconsistent with similar methods that return FilePathCollection. Note that those are paths rather than files.

Methods returning FilePathCollection:

• GlobbingExtensions.GetFiles(ICakeContext, string[])
• GlobbingAliases.GetFiles(ICakeContext, string)
• GlobbingAliases.GetFiles(ICakeContext, string, Func<IDirectory, bool>)

[wwwlicious]

@WalkerCodeRanger Thanks for contributing 👍

I'm assuming you propose changing this to match the other extensions.
This would be a breaking change for existing clients which I try never to do (especially as many people don't pin versions which is the recommended guidance).

Is there a reason other than consistency across different extensions for making this change that I should consider as otherwise I'm relucant to do so?

[WalkerCodeRanger]

Yes, I would propose this be changed to match the other ones.

I understand the concern about it being a breaking change. However, if you let inconsistencies like this build up in the system over time, eventually there will be quite a few and it could be frustrating for users. I assumed part of the reason for the Cake.Incubator add-in was to allow for more changes, including breaking changes, before stabilizing the feature into cake. Would it be possible to change it at the time it moves from incubator into cake proper?

As an aside, I think you should change cake to make pinning the version required or at least the default. Personally, I pinned the version the moment I set it up and would never dream of using it not pinned.

[wwwlicious]

@WalkerCodeRanger you can propose pinning versions by default to the cake team in the main repo.

It is the intent to allow for more changes yes, specifically around adoption of things not already in the main cake project where they can mature and stabilize but making a breaking change to a method signature is still not something I like to do without some thought.

I will consider making this breaking change for version 2 in line with semver.