Meziantou.Framework.FullPath 3.0.11

Meziantou.Framework.FullPath

FullPath ensures you always deal with full path in your application and provides many common methods to manipulate paths.

// Create FullPath
FullPath rootPath = FullPath.FromPath("demo"); // It automatically calls Path.GetFullPath to resolve the path
FullPath filePath = FullPath.Combine(rootPath, "temp", "meziantou.txt"); // Use Path.Combine to join paths (you can combine as many path as you needed)
FullPath temp = FullPath.GetTempPath(); // equivalent of Path.GetTempPath()
FullPath cwd = FullPath.CurrentDirectory(); // equivalent of Environment.CurrentDirectory

// Combine path: you can use the / operator to join path
FullPath filePath1 = rootPath / "temp" / "meziantou.txt";
// Or use the + operator to append a suffix to the current path
FullPath backupFilePath = filePath1 + ".bak";

// Compare path
// Comparisons are case-insensitive on Windows, macOS, iOS and tvOS, and case-sensitive elsewhere by default
_ = filePath == rootPath;
_ = filePath.Equals(rootPath, ignoreCase: false);

// Get parent directory
FullPath parent = filePath.Parent;

// Get file/directory name - extension
var name = filePath.Name;
var ext = filePath.Extension;
FullPath pathWithExtension = filePath.WithExtension(".log");
FullPath pathWithAllExtensionsChanged = FullPath.FromPath("archive.tar.gz").WithExtension(".zip", replaceAllTrailingExtensions: true);
FullPath pathWithTwoExtensionsChanged = FullPath.FromPath("archive.tar.gz").WithExtension(".zip", extensionCount: 2);
FullPath pathWithNewName = filePath.WithName("other.txt");
FullPath pathWithNewNameWithoutExtension = filePath.WithNameWithoutExtension("other");

// Make relative path
string relativePath = filePath.MakePathRelativeTo(rootPath); // temp\meziantou.txt

// Check if a path is under another path
bool isChildOf = filePath.IsChildOf(rootPath);

// Resolve to canonical final path (follows symbolic links/reparse points)
if (filePath.TryGetCanonicalPath(out var canonicalPath))
{
    Console.WriteLine(canonicalPath);
}

// FullPath is implicitly converted to string, so it works well with File/Directory methods
System.IO.File.WriteAllText(filePath, content);

Native AOT and trimming

The package is annotated IsAotCompatible and IsTrimmable. It does not use reflection, and the native interop is resolved at compile time.

FullPath is serialized to JSON as a string by FullPathJsonConverter, which also works with the System.Text.Json source generator:

[JsonSerializable(typeof(Configuration))]
internal sealed partial class AppJsonContext : JsonSerializerContext;

internal sealed record Configuration(FullPath OutputPath);

Analyzer rules

Additional resources

• Simplifying paths handling in .NET code with the FullPath type