Pinecone.TypedPath by Nick Pinecone

NuGet / site data
Details
Original Readme
How to use
Useful

NuGet / site data

Details

Info

info

Name: Pinecone.TypedPath

.NET source generator for strongly typed file paths

Author: Nick Pinecone

NuGet: https://www.nuget.org/packages/Pinecone.TypedPath/

You can find more details at https://github.com/nickpinecone/typed-path

Source: https://github.com/nickpinecone/typed-path

Author

note

Nick Pinecone Alt text

Original Readme

note

Typed Path

.NET source generator for strongly typed file paths

Install

Install the package from nuget

dotnet add package Pinecone.TypedPath

Make sure to include the package as a source generator

<ItemGroup>
    <PackageReference Include="Pinecone.TypedPath" Version="..." ReferenceOutputAssembly="false" OutputItemType="Analyzer" />
</ItemGroup>

Configuration

The Sample project includes the full example

First add the folder to .csproj as AdditionalFiles

<ItemGroup>
    <AdditionalFiles Include="Assets/**" />
</ItemGroup>

Then define a partial class with TypedPath attribute and ITypedPath interface

[TypedPath("Assets")]
public partial class Assets : ITypedPath
{
    public static string Wrap(string path)
    {
        return path;
    }
}

After that you can just reference the path you need

> Console.WriteLine(Assets.SubFolder.NestedFolder.SuperNested);

Assets/SubFolder/NestedFolder/SuperNested.json

Note for Rider

Related to RIDER-75959

While the source generator works with most file types (.json, .png, etc.),
Rider's IntelliSense may not detect changes with .txt and potentially other files.

Builds will still work correctly (this is purely an IDE issue)

About

note

Generating typed paths for file system navigation and manipulation.

How to use

Example (source csproj, source files)

CSharp Project
Program.cs
MyFolder.cs

This is the CSharp Project that references Pinecone.TypedPath

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net10.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>
	
	<ItemGroup>
		<AdditionalFiles Include="MyFolderToShow/**" />
	</ItemGroup>
	<ItemGroup>
    <PackageReference Include="Pinecone.TypedPath" Version="1.0.4" />
  </ItemGroup>
	<PropertyGroup>
		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
		<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath>
	</PropertyGroup>
</Project>

This is the use of Pinecone.TypedPath in Program.cs

using FolderToCode;

Console.WriteLine(MyFolder.en.A);
Console.WriteLine(MyFolder.ro.A);

This is the use of Pinecone.TypedPath in MyFolder.cs

using System;
using System.Collections.Generic;
using System.Text;
using TypedPath;

namespace FolderToCode;

[TypedPath("MyFolderToShow")]
public partial  class MyFolder: ITypedPath
{
    public static string Wrap(string path)
    {
        return path;
    }
}

Generated Files

Those are taken from $(BaseIntermediateOutputPath)\GX

TypedPath.MyFolder.g.cs
TypedPathAttribute.g.cs
TypedPathInterface.g.cs

namespace FolderToCode;

[global::System.CodeDom.Compiler.GeneratedCode("TypedPath", "1.0.0")]
public partial class MyFolder
{
    public static partial class en
    {
        public static readonly string A = Wrap("MyFolder\en\a.json");
    }
    public static partial class ro
    {
        public static readonly string A = Wrap("MyFolder\ro\a.json");
    }
}

using System;

namespace TypedPath;

[global::System.CodeDom.Compiler.GeneratedCode("TypedPath", "1.0.0")]
[AttributeUsage(AttributeTargets.Class)]
public class TypedPathAttribute : Attribute
{
    public string Path \{ get; }
    public bool OriginalFilename \{ get; }

    public TypedPathAttribute(string path, bool originalFilename = false)
    {
        Path = path;
        OriginalFilename = originalFilename;
    }
}

namespace TypedPath;

[global::System.CodeDom.Compiler.GeneratedCode("TypedPath", "1.0.0")]
public interface ITypedPath
{
    public static abstract string Wrap(string path);
}