deptrac icon indicating copy to clipboard operation
deptrac copied to clipboard

Mermaid JS Output Formatter

Open jan-simbera opened this issue 3 years ago • 8 comments

The basic implementation of the MermaidJS formatter.

jan-simbera avatar Aug 05 '22 14:08 jan-simbera

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

patrickkusebauch avatar Aug 05 '22 17:08 patrickkusebauch

@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.

dbrumann avatar Aug 08 '22 07:08 dbrumann

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

gennadigennadigennadi avatar Jun 21 '23 15:06 gennadigennadigennadi

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

jan-simbera avatar Jun 21 '23 18:06 jan-simbera

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?

gennadigennadigennadi avatar Jun 22 '23 06:06 gennadigennadigennadi

@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!

gennadigennadigennadi avatar Jul 28 '23 12:07 gennadigennadigennadi

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

jan-simbera avatar Jul 28 '23 12:07 jan-simbera

What's the status of this PR?

lyrixx avatar Feb 22 '24 16:02 lyrixx

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

jan-simbera avatar Feb 23 '24 09:02 jan-simbera

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

gennadigennadigennadi avatar Mar 14 '24 11:03 gennadigennadigennadi