EditorGuidelines Extension Breaks the Built-In Visual Studio Spell Checker

[EWSoftware]

There seems to be a conflict between the latest Visual Studio 2022 (17.5.4) and the EditorGuidelines extension. The extension is somehow breaking the built in Visual Studio spell checker such that it never completes and offers suggestions for misspelled words. I also notice that this in turn can also block other code fixes as well such that they never show suggestions.

I'm the creator of the Visual Studio spell checker extension and noticed an issue in mine with the smart tags not popping up automatically anymore when you hovered the mouse over a misspelling. Using the shortcut key to show the suggestions worked but there was always a "Loading suggestions" item at the bottom with a continuous progress bar.

Thinking the issue was in my extension I removed it and still saw similar issues with other standard code fixes not offering suggestions. As such, I started disabling other extensions to try and track down the cause. After disabling the EditorGuidelines extensions, everything started working again and I noticed that the built in Visual Studio spell checker was enabled and offering suggestions. I hadn't noticed it was enabled before due to it being blocked and perhaps not enabled until this latest Visual Studio update.

After enabling the EditorGuidelines extension, the built-in spell checker suggestions went away again. However, if I press the shortcut key to show suggestions on a misspelled word, the popup appears with the same "Loading suggestions" message and progress bar as shown below and it never completes.

With the guidelines extension disabled, the popups work as expected in my own extension as well. As noted, I hadn't noticed this behavior prior to the 17.5.4 update. Also, disabling the built in Visual Studio spell checker fixes the issues as well so the conflict does appear to be with it specifically.

[pharring]

Thanks for the report. I will investigate and try to reproduce it.

[pharring]

Reproduced. Debugging.

[pharring]

The problem is with Microsoft.VisualStudio.CodingConventions
This is the assembly we use to read .editorconfig files.
The version included with EditorGuidelines (1.1.20180503.2) is incompatible with the one that ships in 17.5.4
It looks like that assembly has been de-listed from nuget.org. I need to find a replacement.

[pharring]

I think I have a fix.
We use the de-listed assembly at build time, but don't include the assembly in the VSIX. Instead, it'll be picked up from PublicAssemblies. I'm assuming that the CodingConventions assembly is available in all SKUs and all workloads.

[pharring]

I think it's fixed. I will try to get a new release published tomorrow.

[pharring]

The fix has been published in version 2.2.10 to the VS Marketplace.

[EWSoftware]

It's working as expected now. Thanks for the quick fix.

[prlcutting]

As a user of both the Editor Guidelines and Spell Checker extensions, I noticed the same behavior recently, but had no idea what the cause was. Thank you for the rapid fix.

And thank you both for the fantastic extensions that you maintain for the community. It is much appreciated.