dotnet/roslyn

Source Generators: Allow more than one subfolder for hintnames

Open

#70,859 opened on Nov 16, 2023

View on GitHub
 (3 comments) (4 reactions) (0 assignees)C# (4,257 forks)batch import
Area-CompilersFeature Requesthelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

Brief description:

I want to sort my generated types into folders so that the structure looks like this in the IDE

Dependencies -> .. -> Source Generators -> Foo -> Bar -> Baz.g.cs

Where Foo and Bar are folders (Foo a folder in Source Generators and Bar a subfolder of Foo)

I can add folders to the hintname - the documentation says so too. But what it doesn't reveal is that if you use more than one folder it only uses the last folder. So in the given example above the structure would look like this

Dependencies -> .. -> Source Generators -> Bar -> Baz.g.cs

Foo was omitted

/// <summary>
/// Adds a <see cref="SourceText"/> to the compilation
/// </summary>
/// <param name="hintName">An identifier that can be used to reference this source text, must be unique within this generator</param>
/// <param name="sourceText">The <see cref="SourceText"/> to add to the compilation</param>
/// <remarks>
/// Directory separators "/" and "\" are allowed in <paramref name="hintName"/>, they are normalized to "/" regardless of host platform.
/// </remarks>
public void AddSource(string hintName, SourceText sourceText) => Sources.Add(hintName, sourceText);

Contributor guide

Research direction
Locate the AddSource method implementation in the Roslyn source code and inspect how it handles the hintName parameter, specifically how directory separators are processed. Determine why only the last subfolder is retained instead of preserving the full path. Check if there is a normalization step that collapses multiple directory separators.
Tech stack
csharp
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Source Generators basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75