Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for an !include file (optional) that would have settings #109

Open
fuhrmanator opened this issue Jul 28, 2023 · 5 comments
Open

Comments

@fuhrmanator
Copy link
Contributor

I want to use this in a CI on Github to create PlantUML documentation of my API. But I don't want to see all the methods or attributes in the diagrams.
I'd like to insert a line hide members. But maybe I also want to hide circle or other customizations. I don't want to hack something with sed (but I will probably end up doing that).

It would be cool if tplant had an option -config <includefile> that would include the file just after the @startuml that is generated.

@bafolts
Copy link
Owner

bafolts commented Jul 28, 2023

@fuhrmanator this tool is proving popular. Problem is I don't use plantuml that often and I am not too familiar with it. Can you provide sample input, output, and how you would provide the option?

@fuhrmanator
Copy link
Contributor Author

Here's an example (the tplant tool would have to generate the !include line):

@startuml
!include customizations.puml
...
@enduml

A customizations.puml could be like:

hide members
skinparam style strictuml

So, the command could be tplant --customizations customizations.puml ...

@fuhrmanator
Copy link
Contributor Author

Basically, it's an optional hook to allow custom plantuml commands (any) from a specified file to be inserted after the line of @startuml. PlantUML has the !include feature already; tplant just has to write that one line (it doesn't need to even check if the file exists).

@bafolts
Copy link
Owner

bafolts commented Jul 31, 2023

Makes sense to me. I may try to get PR ready for this but have limited time over next few weeks.

@fuhrmanator
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants