cake-build / cake-build/cake

Consider adding IFileSystemInfo returning APIs in addition to IFile and IDirectory

Open
#4,660 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.2k
Forks
778
Avg merge
1h 15m
Merged PRs (30d)
19

Description

### Prerequisites

- [x] I have written a descriptive issue title
- [x] I have searched [issues](https://github.com/cake-build/cake/issues) to ensure it has not already been reported

### Cake runner

Cake Frosting

### Cake version

6.0.0

### Operating system

N/A

### Operating system architecture

x64

### CI Server

_No response_

### What are you seeing?

APIs like `IFileSystem`, `IDirectory` and `GlobberExtensions` have APIs that return either `IFile` or `IDirectory`, but, some times, we just want a file system entry and decide what to do with it based in whether it's a file or directory.

### What is expected?

`context.FileSystem.GetFileSystemInfo(path)`
`context.Globber.GetFileSystemInfos(pattern)`
`directory.GetFileSystemInfos()`

### Steps to Reproduce

Try getting a list of file system infos that contains both files and directories,

### Output log

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by locating the IFileSystem, IDirectory, and GlobberExtensions APIs mentioned in the issue, then inspect their existing IFile and IDirectory return patterns and related tests. Define the scope for returning file-system entries from the three requested entry points; done means mixed file and directory results are supported consistently and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.