Comment on raw string literal is lost when file is formatted.

[Tyrrrz]

Repro: run dotnet build on Tyrrrz/YoutubeExplode@78680d3

Here's the build log: https://github.com/Tyrrrz/YoutubeExplode/actions/runs/5942894160/job/16116827695

As you can see, it errors out on the // lang=json comment for some reason.

Here's the code it fails on:

https://github.com/Tyrrrz/YoutubeExplode/blob/78680d3f087285767f96d170a46f70bae01fa524/YoutubeExplode/Search/SearchController.cs#L21-L51

[belav]

This failure is coming from the syntax tree validation, because csharpier is eating the // lang=json line. After formatting code it compares the resulting syntax trees to ensure nothing was lost or changed in an unexpected way.

If that doesn't serve a special purpose you could move it above Content = new StringContent( to get things working.

[Tyrrrz]

This failure is coming from the syntax tree validation, because csharpier is eating the // lang=json line. After formatting code it compares the resulting syntax trees to ensure nothing was lost or changed in an unexpected way.

Yeah, that's what I figured. I have similar pieces of code where CSharpier does not eat the same comment. Here, for instance:

https://github.com/Tyrrrz/YoutubeExplode/blob/78680d3f087285767f96d170a46f70bae01fa524/YoutubeExplode/Videos/VideoController.cs#L58-L81

I have a few instances of these, and the only one that causes the issue is the one mentioned in the issue description.

If that doesn't serve a special purpose you could move it above Content = new StringContent( to get things working.

It does actually serve a purpose: it marks the following string literal as a language injected string for JetBrains tools. It allows syntax highlighting inside it for the specified language (in this case, JSON).

https://www.jetbrains.com/help/rider/Language_Injections.html

---

As an aside, I really like CSharpier! You've done a great job. I've added it to all my projects. I learned about it from this discussion: https://twitter.com/Tyrrrz/status/1693941083896422545

[belav]

As an aside, I really like CSharpier! You've done a great job. I've added it to all my projects. I learned about it from this discussion: https://twitter.com/Tyrrrz/status/1693941083896422545

Thanks! It has been awesome to see it slowly spreading around twitter/reddit/etc over time.

That second working example made me start to wonder why that first one wasn't working, and it has something to do with the switch expression in the raw string literal. This version should give you a work around for now.

using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using YoutubeExplode.Bridge;

namespace YoutubeExplode.Search;

internal class SearchController
{
    private readonly HttpClient _http;

    public SearchController(HttpClient http) => _http = http;

    public async ValueTask<SearchResponse> GetSearchResponseAsync(
        string searchQuery,
        SearchFilter searchFilter,
        string? continuationToken,
        CancellationToken cancellationToken = default
    )
    {
        var value = searchFilter switch
        {
            SearchFilter.Video => "EgIQAQ%3D%3D",
            SearchFilter.Playlist => "EgIQAw%3D%3D",
            SearchFilter.Channel => "EgIQAg%3D%3D",
            _ => null
        };

        using var request = new HttpRequestMessage(
            HttpMethod.Post,
            "https://www.youtube.com/youtubei/v1/search"
        )
        {
            Content = new StringContent(
                // lang=json
                $$"""
                {
                    "query": "{{searchQuery}}",
                    "params": "{{value}}",
                    "continuation": "{{continuationToken}}",
                    "context": {
                        "client": {
                            "clientName": "WEB",
                            "clientVersion": "2.20210408.08.00",
                            "hl": "en",
                            "gl": "US",
                            "utcOffsetMinutes": 0
                        }
                    }
                }
                """
            )
        };

        using var response = await _http.SendAsync(request, cancellationToken);
        response.EnsureSuccessStatusCode();

        return SearchResponse.Parse(await response.Content.ReadAsStringAsync(cancellationToken));
    }
}

[belav]

Ah yeah, when a interpolated string contains c# expressions with a new line, CSharpier bails out of trying to format that string. But it didn't keep into account any leading comments when doing so.

[Tyrrrz]

Nice! Thank you for investigating this :)