Feature: Show, index and search Types within packages

Do you want to request a feature or report a bug?

Feature

What did you expect to see?

It’d be awesome for companies and groups using BaGet, to be able to search for Types within their packages. Since the number of packages is relatively small (compared to Nuget), it should be doable.

Internally, we usually have the question, “I know we have a XYZ helper, but I can’t find it”, so searching in a neat and fast UI would be very helpful, and be something most projects don’t have.

I imagine that the following things be searchable:

• Public types (Instance types, statics, abstracts, interfaces, structs, …)
  • Name, Full name, Xmldocs if present
• Public methods (GetFileInfo())
  • Name, Type, Xmldocs if present
  • This is a maybe - search results may be too cluttered with 100’s of ToString()'s
  • Some methods should be ignored, such as all those of object, IDisposable, …

If we go further, special care would be taken for:

• Roslyn analyzers
  • Name of analyzer
  • Names of individual analyzers, quickfix tools, etc.
  • Xmldocs if present

[LordMike]

I have a working prototype, but it’s a bit on the slow side. Currently it uses 5½ minutes for NEST 6.4.0 (net461 assembly). So this could easily be a half/whole hour for similar packages (that target multiple frameworks). It does steps 2, 3 and 4. I haven’t made a nupkg adaption yet.

I’ll look into the speed.

I also quickly looked at docfx, to see how they made their docs. They had a lot of code for browsing solutions and projects. Do you know if it’s a “from source” only project? Would’ve been nice to have had this already 😃

Prototype: NEST-6.4.0-net461.json.zip

[LordMike]

@loic-sharma if I were to do a poc - how should I proceed? … Produce code that takes in a nupkg and produces this object? – then we can embed it in a process later.