How to extend CodeLens

Question

I'm currently writing a tool to help maintain unit and integration tests (coded tests). I've started extending Visual Studio to make the developer experience nicer, which got me to notice the new-ish CodeLens feature.

The stuff I'm currently showing as a tooltip should probably actually be part of the CodeLens info.

Question: Does anyone know how to extend CodeLens in Visual Studio?

Thanks.

Answer 1

Code Lens is not currently extensible.

I can't say for sure, but I think there are still some features the team wants to add before they open it up for extension (e.g. git support).

Answer 2

As @RichardBanks says, officially CodeLens is not extensible. Technically I think it may be possible at the moment. Look for *CodeSense*.dll in the visual studio directory for hints. There is no documentation at present and the API can still change going forward.

I suggest you'd venture into this for research purpose only, distributing any 'plugin' seems like a very bad idea until Microsoft opens up the API, which they probably will.

Answer 3

CodeLens is officially extensible since Visual Studio 2019 was released.

CodeLens for Everyone

CodeLens has been a feature found only in Visual Studio Enterprise, but that will change in an upcoming preview of Visual Studio 2019, when it will also be available for the Community edition, likely in 2019. CodeLens shows the number of references a type or method has, information about unit tests covering the method, and data directly from Application Insights.

In addition, Microsoft has made CodeLens fully extensible¹, so third-party extensions can start to add their own experiences on top of it. CodeLens makes key information about your types easy to find, while keeping you in the source code. Lenses for source control history and IntelliTrace are still an Enterprise-only feature.

Looks like this is the best place to start looking at when implementing your own CodeLens extension.

---

_{1. Highlight mine.}