[BUG]: C# `nameof` incorrectly flagged as spelling error

[andrewlock]

Issue Description

Hi, thanks for this! I'm just trying out Zed for the first time, and a spell check is essential so was very happy to find this extension. I saw that C# said it needs validation so decided to give it a try and noticed that nameof flagged as spelling errors that shouldn't be. The interesting thing is that it was only flagged when part of an interpolated string, not in "normal" usage:

I had a look around and couldn't find any other issues, nice work!

Operating System

Windows

Editor

Zed

Codebook Version

0.2.2

Configuration

I'm using the zed extension and haven't customised, I wasn't sure where to find the config

Steps to Reproduce

Install the extension, open C# project

Expected Behavior

None of the nameof should be flagged as a spelling error

Actual Behavior

The nameof calls inside the string interpolation are flagged as spelling errors

Code Sample

The following C# demonstrates the issue (in the interpolated strings)


using System.Diagnostics;

// Incorrectly flagged
[DebuggerDisplay($"{{{nameof(GetDebuggerDisplay)}(),nq}}")]
internal class Program
{
    private static void Main(string[] args)
    {
        // Incorrectly flagged
        Console.WriteLine($"Hello, {nameof(Program)}!");

        // Incorrectly flagged
        Console.WriteLine(
            $$"""
            Hello {{nameof(Program)}}!
            """);
    }
    private string GetDebuggerDisplay()
    {
        // OK
        return nameof(Program);
    }
}

Log Output

Additional Context

No response

[jusexton]

Hello! I'm not the owner but I can chime in really quick.

The reason this only happens during interpolation is because codebook only looks at strings/interpolations and construct definitions, not invocations. Because the nameof invocation is within a interpolated string, codebook is treating it as a word within a string.

@blopker I was able to resolve this by creating a dictionary of C# keywords with the below. This should also cover other "misspelled" C# keywords that are often interpolated. If you had something else in mind let me know! Otherwise I can create the PR.

static TEXT_DICTIONARIES: LazyLock<Vec<TextRepo>> = LazyLock::new(|| {
        ...,
        TextRepo::new(
            "csharp",
            "https://raw.githubusercontent.com/streetsidesoftware/cspell-dicts/refs/heads/main/dictionaries/csharp/csharp.txt",
        ),
        ...
    ]
});

EDIT: Seems like adding "nameof" to word_lists/c_sharp.txt and re-generating combined.gen.txt would also do the trick.

[andrewlock]

So the interesting thing was that it only seemed to be nameof that was a problem in interpolation - typeof for example wasn't flagged? 🤔 Not sure if that would still be expected, just mentioning it incase 😃

[jusexton]

Ah, I gotcha.

One of the word lists codebook uses is streetsidesoftware's cspell-dicts/software-terms and in that list appears to have "typeof" and probably many other words that aren't being flagged for you. "nameof" is not covered in that list though.

[blopker]

Hey everyone! Thanks for the report. I don't know C# myself, so I wasn't able to really evaluate the implementation myself, so this kind of feedback is super helpful. I took a look at the issue, and there were a few problems with the original set of queries. I've done 2 things: 1) made a more specific query for interpolated_string_expression, that only grabs the non-interpolated content, and 2) added the csharp dictionary mentioned.

1 should have been enough to fix this issue, but I think the Tree Sitter grammar we're using has a bug in it where it correctly tags the normal interpolated string case, but gets real confused with the class annotation case. It tags the whole string as normal string content.

PR: #146

[blopker]

PR merged! This will be fixed in the next release. Thanks!