Ramstack.FileProviders.Extensions 2.1.0-preview.3

Ramstack.FileProviders.Extensions

Represents a lightweight .NET library of useful and convenient extensions for Microsoft.Extensions.FileProviders that enhances file handling capabilities in .NET applications.

Getting Started

To install the Ramstack.FileProviders.Extensions NuGet package in your project, run the following command:

dotnet add package Ramstack.FileProviders.Extensions

Overview

The library provides useful extensions for IFileProvider, bringing its capabilities and experience closer to what's being provided by DirectoryInfo and FileInfo classes.

Simply stated, a FileNode knows which directory it is located in, and a directory represented by the DirectoryNode class can access its parent directory and list all files within it, recursively.

FileNode file = provider.GetFile("/docs/README");

// Prints the full path of the given file
Console.WriteLine($"Reading: {file.FullName}");

using StreamReader reader = file.OpenText();
Console.WriteLine(reader.ReadToEnd());

DirectoryNode directory = provider.GetDirectory("/docs");

foreach (FileNode file in directory.EnumerateFiles())
    Console.WriteLine(file.FullName);

Furthermore, the methods for enumerating files (EnumerateFiles/EnumerateDirectories/EnumerateFileNodes) allow specifying glob patterns to search for the desired files, as well as patterns to exclude files from the resulting list.

It relies on the Ramstack.Globbing package for its globbing capabilities.

DirectoryNode directory = provider.GetDirectory("/project");

// Finds all *.md files and converts them to HTML
foreach (FileNode file in directory.EnumerateFiles(pattern: "**/*.md"))
    RenderMarkdown(file);

// Excludes files in a specific folder
foreach (FileNode file in directory.EnumerateFiles(pattern: "**/*.md", exclude: "vendors/**"))
    RenderMarkdown(file);

For convenience, many methods specific to DirectoryNode or FileNode are also available for IFileProvider.

Thus, if we know the directory in which to look for files or the file to read, there is no need to obtain the DirectoryNode or FileNode object.

using StreamReader reader = provider.OpenText("/docs/README", Encoding.UTF8);
Console.WriteLine(reader.ReadToEnd());

// Finds all *.md files and converts them to HTML
foreach (FileNode file in provider.EnumerateFiles("/project", pattern: "**/*.md"))
    RenderMarkdown(file);

Related Packages

• Ramstack.FileProviders — Additional file providers.
• Ramstack.FileProviders.Globbing — Wraps the file provider, filtering files and directories using glob patterns.
• Ramstack.FileProviders.Composition — Provides a helper class for flattening and composing IFileProvider.

Supported versions

Contributions

Bug reports and contributions are welcome.

License

This package is released as open source under the MIT License. See the LICENSE file for more details.