[ANN] Sherlock.jl : A visual package detective

Hey everyone, I’m happy to announce Sherlock.jl. GitHub - caseykneale/Sherlock.jl: A high functioning package detective.

What is it? Well it provides convenience functions to explore modules that are loaded into scope! You can visually check an entire package and what methods connect to what functions, etc. But also “inspect” types to see what goes into them and what comes out of them, or their type trees. It makes heavy use of the LightGraphs.jl package scape

It has a WebUI running off of Blink for convenience, but also command line accessible functions(lacking an official docs right now).

I hope to include it into Documenter.jl in some way so people can autogenerate something like a UML of their packages.

It’s a super early release - so it isn’t perfect, it needs: feedback, bug reports, suggestions, contributions!, and whatever else are highly appreciated. Thank you for reading,

43 Likes

Really cool name and cool repo description :wink:

1 Like

I may have had some inspiration from the awesome : https://github.com/JuliaDynamics/DrWatson.jl :).

1 Like

Found a really cool VSCode plugin that supports the kind of functionality I wanted in Sherlock.jl, but don’t have in Julia.
https://github.com/foambubble/foam

the plugin/extension might interest some people, but I’m wondering if someone more seasoned with typescript would want to make the foam version of a julia package inspector? I’d really love that…