Roslyn Analyzer - Access to ITextBuffer

Question

Is it somehow possible to have access to the ITextBuffer instance of the document that is being analyzed by a Roslyn diagnostic analyzer in Visual Studio. Or at least the filename, so that I can retrieve the ITextBuffer myself?

For more information on how to write a custom code analyzer for c#, see: https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/tutorials/how-to-write-csharp-analyzer-code-fix

Its probably better to describe the actual problem you are trying to get the buffer for to solve, as maybe there is a better solution to that problem, than trying to get the buffer — Sam Holder
– Sam Holder, Commented Jun 25, 2019 at 9:24

jmoreno · Accepted Answer · 2019-06-23 23:40:06Z

2

The SyntaxTree has a property FilePath, as does the Document, which if not the empty string, would be the path to the file.

No idea how to go from that to the buffer. But it’s also unclear why you would want the buffer...

answered Jun 23, 2019 at 23:40

jmoreno

13.7k6 gold badges66 silver badges103 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

JoshVarty · Accepted Answer · 2019-06-20 21:19:14Z

In general, the infrastructure around analyzers was created to allow them to run outside of Visual Studio (eg. from commandline or as part of a CI build system). This is why there aren't many easy ways to interop between Roslyn and Visual Studio. However there are a few different extension methods that can help you bridge the gap between Visual Studio and Roslyn.

I believe you need to:

Add the NugetPackage with Install-Package Microsoft.CodeAnalysis.EditorFeatures.Text
Add the using using Microsoft.CodeAnalysis.Text; to your analyzer

If you have access to a Document you can use .TryGetText(out SourceText) to retrieve the SourceText for a document.

Then you can use the extension method FindCorrespondingEditorTextSnapshot to get an ITextSnapshot.

My knowledge here is a little shakey but I'm not sure if you can get an ITextBuffer because your analyzer will often be running when no editor is opened for a given file so no ITextBuffer has been created for it.

Collectives™ on Stack Overflow

Roslyn Analyzer - Access to ITextBuffer

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related