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

fix: improve how plantuml namespaces are rendered #615

Merged
merged 2 commits into from
Mar 8, 2023
Merged

Conversation

dselman
Copy link
Contributor

@dselman dselman commented Mar 8, 2023

Today the PlantUML diagram is messy because PlantUML interprets all dots in fully-qualified names as packages names, and renders a box for the contained elements.

Changes

  • Changes the string escaping function for PlantUML to escape the dots that appear in versioned namespaces to underscores

Screenshots or Video

Note that boxes have been drawn for the org and acme and test namespaces, but not for the version of the [email protected] namespace.

image

Related Issues

  • Issue #
  • Pull Request #

Author Checklist

  • Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
  • Vital features and changes captured in unit and/or integration tests
  • Commits messages follow AP format
  • Extend the documentation, if necessary
  • Merging to main from fork:branchname

@dselman dselman requested review from a team and mttrbrts March 8, 2023 15:00
Copy link
Member

@mttrbrts mttrbrts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a test

Signed-off-by: Dan Selman <[email protected]>
@dselman
Copy link
Contributor Author

dselman commented Mar 8, 2023

Please add a test

I think this is pretty well covered by our snapshots. Somehow coverage increased which is a bit surprising! :-)

@dselman dselman requested a review from mttrbrts March 8, 2023 15:22
@mttrbrts mttrbrts merged commit f50796b into main Mar 8, 2023
@mttrbrts mttrbrts deleted the ds-plantuml-ns branch March 8, 2023 15:31
@mttrbrts
Copy link
Member

mttrbrts commented Mar 8, 2023

Somehow coverage increased which is a bit surprising! :-)

More LoC, which were already covered by existing tests, means a greater proportion of LoC covered?

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.

2 participants