Nest: Tooling: dependencies analyzer (like Compodoc)

[ericzon]

I'm submitting a...

[ ] Regression 
[ ] Bug report
[x] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Certainly, to generate documentation to help with integrations, we already have a working Swagger, but in this case I refer to a different kind of tool, something more faced to trace all dependencies and help to find bottle necks.

Expected behavior

Would be great to have a useful tool like this:
https://github.com/compodoc/compodoc

What is the motivation / use case for changing the behavior?

Angular lovers have a great tool like this, that it helps a lot with its developments.

Example

Environment

Nest version: 4.6.6

[kamilmysliwiec]

I'd love to see this kind of tool as well. Maybe we can reuse a compodoc in some way. If anybody is working on something like this already, please, let me know. I'll help as much as I can 🙂 Otherwise, I'll try to go deeper as soon as I have a bit more time.

[ThomRick]

Hey guys !

Do you know http://hawt.io/ for Java apache Camel library ?
I would love to develop a cli feature or an app based on nest framework and using cli to manage nest applications like that.

The idea is to provide a GUI to :

• drag & drop architecture components to help designing application (the cli will generate basic code)
• track server activity (number of requests on each routes)
• activate / disable routes (for toggle features for example)
• more if their are other application management features

We've got a cli opened issue asking for developing a route summary tool feature. Maybe it's a start...
Let me know if you think this idea seems to be cool ;-)

[kamilmysliwiec]

Sounds awesome @ThomRick! +1

[vogloblinsky]

@kamilmysliwiec
I am the author of Compodoc.
I have a project in my company build with Nest and Angular.
I think i will extend Compodoc to support Nest projects, with an option --nest for example.
The related feature is created here : https://github.com/compodoc/compodoc/issues/625

[vogloblinsky]

For information, release 1.1.4 of Compodoc is out with Nest projects partial support. Need some work on controllers.
Feel free to test it inside your app !

npm i -D @compodoc/compodoc
npx compodoc -p tsconfig.json -s

[kamilmysliwiec]

Fantastic news @vogloblinsky! 🙂
Once Compodoc fully supports Nest, we could mention it in the official documentation. Feel free to create a PR anyway :) And if you use Nest in your company, I encourage you to visit this thread #1006

[vogloblinsky]

@kamilmysliwiec or another people
I am not a current daily user of Nest. A feedback from a daily user could be easiest for me to list what i need to add inside Compodoc to fully support Nest.

The corresponding issue is here : https://github.com/compodoc/compodoc/issues/630

Thanks by advance

[kamilmysliwiec]

Since Compodoc introduced Nest support, we'll stick with this tool and hopefully, the future will bring us even better integration!

[lock[bot]]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.