TedToolkit.FileSystem.ProjectPaths 2026.7.15

TedToolkit.FileSystem.ProjectPaths

TedToolkit.FileSystem.ProjectPaths generates strongly typed DirectoryPath and FilePath members for the files and directories you explicitly select from the current Git work tree.

It provides compile-time path access without hard-coding paths throughout an application:

var repository = ProjectPaths.Git;
var project = ProjectPaths.Project;
var settings = ProjectPaths.src.App.appsettings_Development_json;

Only paths declared in the project file are generated. Selecting a directory never implicitly generates its children.

Requirements

• The project must be inside a Git work tree.
• The git executable must be available on the build machine's PATH.
• The generated code uses TedToolkit.FileSystem.DirectoryPath and TedToolkit.FileSystem.FilePath; this dependency is included by the package.

Install

Add the package to the project that needs the generated paths:

<PackageReference Include="TedToolkit.FileSystem.ProjectPaths" Version="*" PrivateAssets="all" />

Select paths

Add one TedToolkitFileSystemPath item for every file, directory, or pattern that should become available through ProjectPaths. Paths are relative to the Git work tree root, not to the project file.

<ItemGroup>
  
  <TedToolkitFileSystemPath Include="src/App/Assets" Kind="Directory" />

  
  <TedToolkitFileSystemPath Include="src/App/*.json" Kind="File" />

  
  <TedToolkitFileSystemPath Include="src/App/**/*.json" Kind="File" />

  
  <TedToolkitFileSystemPath Include="src/App/appsettings.Development.json" Kind="File" />
</ItemGroup>

Kind accepts File, Directory, or Any; it defaults to Any. Use File or Directory when the expected path type is known.

Include supports these glob tokens:

Patterns select only entries whose Kind matches. A selected directory generates its Directory property, but never generates its files or child directories unless they are selected by another item.

Name is optional and applies only to files. Use it to override a generated file member name when a file name would be unclear or conflicts with another file member:

<TedToolkitFileSystemPath Include="src/App/appsettings.Development.json"
                          Kind="File"
                          Name="DevelopmentSettings" />

Generated API

Every project receives one generated ProjectPaths class in the project's root namespace:

public static class ProjectPaths
{
    public static DirectoryPath Git { get; }

    public static FilePath Project { get; }
}

• ProjectPaths.Git is the Git work tree root.
• ProjectPaths.Project is the .csproj file that references this package.
• Each generated directory is a static class with a Directory: DirectoryPath property.
• Each generated file is a FilePath property.

For the preceding configuration, usage looks like this:

var assetsDirectory = ProjectPaths.src.App.Assets.Directory;
var settingsFile = ProjectPaths.src.App.appsettings_Development_json;

The generated ProjectPaths class is placed in the project's RootNamespace. Import that namespace before using it from another namespace:

using MyProject;

var configuration = ProjectPaths.src.App.appsettings_Development_json;

Generated XML documentation contains the corresponding full path, so the path is visible in IntelliSense.

Member names

Directory names preserve their original casing. File names also preserve casing, while characters that are not valid in C# identifiers are replaced with one underscore. Consecutive invalid characters produce only one underscore.

If two selected files produce the same member name, the build reports TTFS002. Set Name on one of the file items to resolve it.

Diagnostics