PHP-CSS-Parser icon indicating copy to clipboard operation
PHP-CSS-Parser copied to clipboard

[DOCS] Regenerate the class diagram in the README

Open oliverklee opened this issue 8 months ago • 6 comments

The class diagram is (almost) unchanged to the output from tasuku43/mermaid-class-diagram, except for the kept direction LR.

This is in preparation for adding a script for auto-creating the class diagram in #1297.

oliverklee avatar Jun 29 '25 14:06 oliverklee

Coverage Status

coverage: 59.658%. remained the same when pulling 3da94d46c18f93848620cf5d78690ed854a4560b on docs/update-class-diagram into f5ad2e777f93cfeacd7fc35fef2ed1061e753299 on main.

coveralls avatar Jun 29 '25 14:06 coveralls

Marking this as draft for now. I'll first reorder the classes in the diagram to make this PR here a bit smaller.

oliverklee avatar Jun 29 '25 14:06 oliverklee

It would be nice if the diagram had fewer criss-crossing paths. AI should be good at that, but seems to be vastly overrated :/

JakeQZ avatar Jun 30 '25 01:06 JakeQZ

So we no longer identify the property that has the dependency (or whether it's as a single object, array, or whatever). Is there any reason for this change?

The old version of the generator which we used did not recognize associations at all. That's why I manually added those to the diagram, including the name of the corresponding property.

The current version of the generator does recognize associations, even though it only labels them as "dependency", but not with the name of the corresponding property.

oliverklee avatar Jul 03 '25 16:07 oliverklee

I think this needs three separate pre-patches so the diffs can be more clearly seen

Makes sense, will do.

oliverklee avatar Jul 04 '25 07:07 oliverklee

Okay, putting this on the backburner until the diagram generator has these two bugfixes/features.

I've created two tickets for that:

  • https://github.com/tasuku43/php-mermaid-class-diagram/issues/26
  • https://github.com/tasuku43/php-mermaid-class-diagram/issues/27

oliverklee avatar Jul 09 '25 12:07 oliverklee