I'd like to discuss some improvements I made

[0815fox]

Hi Gottlieb! First thank you for this nice idea and the very nice work. I did not even know about PlantUML.

It's an honor to write the first ticket here. I forked your project and did some improvements, which I'd like to discuss about. Also I would like to know, whether you were interested to work together on this.

What I did so far:

• added support for automatically generating class diagrams from typescript source
• in case of local plantuml the RemoteURL is not first inserted and then searched & replaced again
• user can also specify another remote url
• added progress bar while generating uml
• added following configuration options:

--umlClassicHierarchy               none,before,behind
 --umlComplete                       none,simple,detail
 --umlFormat                         png,svg
 --umlHierarchy                      none,simple,detail,alldetail
 --umlHierarchyDepthDown             [-1,∞)
 --umlHierarchyDepthUp               [-1,∞)
 --umlLocation                       /^local|remote|(?:https?:\/\/)?[^ "]*$/
 --umlSeperateClassDetailView        true|false
 --umlShowSpot                       true|false
 --umlTag                            true|false
 --umlThreads                        [1,∞)
 --umlVisibilityIcons                none,ascii,graphic

• added lots of documentation for lots of changes

(Sorry, working on a business project - I am not allowed to share the fancier class diagrams, but it works - even multiple implements/extends-paths...)

Some other things to mention:

• sorry, I had to touch your code hard to make it more universal for the case of generating class diagrams... (Still, I owe you a beer, because without what has been there, I would never have done this)

What still is open, before I submit a pull request:

• If you agree I'd like to switch to typescript
• The test script is broken, I have to look into this...
• I'd like to add some more modularity (eventually after moving to TypeScript), if you agree
• The members-generation for class diagrams (generics, types, abstract, visibility) is not yet implemented
• Probably more, if it comes to my mind, I will add it.
• does it also work in --mode modules and with other templates?

Thank you for your feedback :-) Greetings, Michael

[meirgottlieb]

Wow. Great stuff! I'm fine with switching to TypeScript. That would be great. If you do that, take a look at the latest plugins in TypeDoc. He's now doing them using a class with decorators instead of the function for the plugin like I'm doing.

[0815fox]

Oh thats interesting... Thank you. Have you any links about that topic (did not yet find decorators in his documentation)? Is there a thread in which you read that? Where can I find a sample plugin?

[meirgottlieb]

Here is an example of one of the newer plugins. You see it uses a decorator to define the Component. It's also using a base class that helps wire up the events it's listening too. If you look at the converter source, you can see options being defines with a decorator as well.

[slollar]

I was wondering if 0815fox's code was ever merged or created elsewhere. I would really like to have the automatically generated from typescript portion! Thanks!

[meirgottlieb]

No, a pull requested was never submitted.

[slollar]

Dang...thanks for the quick response!

[meirgottlieb]

His branch is public so maybe you can just use that: https://github.com/0815fox/typedoc-plantuml

[slollar]

Thanks - I found this too https://www.npmjs.com/package/typedoc-plantuml-extended which looks like the same thing.

[0815fox]

Of course you can use it. I stopped working on it because other things became more important in our small business (3 people working on our project). I didn't submit a pull request because of the mentioned change in the way plugins are loaded.

[krisztianb]

I just wanted to let you know that the package typedoc-plantuml-extended posted by @slollar, which is the extension created by @0815fox is working with the latest 0.15.0 typedoc. And so does the original typedoc-plantuml package by @meirgottlieb.