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

Mermaid JS Output Formatter #948

Closed

Conversation

jan-simbera
Copy link
Member

The basic implementation of the MermaidJS formatter.

@patrickkusebauch
Copy link
Collaborator

I think it is somewhat better as an extension. That's why https://github.com/Dance-Engineer/deptrac-awesome/blob/main/src/OutputFormatters/MermaidJsFormatter.php exists

@dbrumann
Copy link
Collaborator

dbrumann commented Aug 8, 2022

@patrickkusebauch I think it's fine to have this formatter in the core. I would like to replace some of the static images in the docs with the the MermaidJS-output at some point. I also have some vague ideas for features around this, e.g. extracting layers and rules from a diagram and then turning it into a depfile-template with basic formatters based on the names.

@gennadigennadigennadi
Copy link
Member

@jan-simbera The current implementation does not color a violations graph red, right?

@jan-simbera
Copy link
Member Author

No, it only displays the results. No colored graph yet. Is it still considered to be added? Should I implement that additional? @gennadigennadigennadi

@gennadigennadigennadi
Copy link
Member

Yes, it would be nice to have the same featureset as the graphiz-image has.

@jan-simbera I don't know how someone would use the current output of the formatter, it gets dump straight into the stdout. Therefor I'm asking my self, if we should also use the -o-Flag to write the output into a file?

And could you also implement a test, that verifies the current output-format?

@jan-simbera jan-simbera force-pushed the mermaidjs-output-formatter branch from 0c667aa to 8e9e6e2 Compare July 17, 2023 09:34
@jan-simbera jan-simbera force-pushed the mermaidjs-output-formatter branch from f76c87b to eccacb3 Compare July 20, 2023 10:03
@gennadigennadigennadi
Copy link
Member

@jan-simbera Im okay with merging this branch, but would you also be willing to work on the php-config of the mermaidjs-formatter?
And it's also necessary to update the documentation!

@jan-simbera
Copy link
Member Author

Yeah, should I create a new MR, or should I add it to this one?

@lyrixx
Copy link

lyrixx commented Feb 22, 2024

What's the status of this PR?

@jan-simbera
Copy link
Member Author

Documentation pending, small changes pending, I could get to finish this next week.

@gennadigennadigennadi
Copy link
Member

Please update the git origin for development to https://github.com/qossmic/deptrac-src and reopen the PR.
Thank you very much!

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

Successfully merging this pull request may close these issues.

5 participants