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

Output graph files to target directory and improve Graphviz output #1167

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ggiraldez
Copy link
Contributor

@ggiraldez ggiraldez commented Nov 27, 2024

The graph files .mmd and .dot files are not committed to the repository and hence writing them to the source directory (inside the generated folder) does not provide any benefit and even has some drawbacks (eg. build errors when switching branches and test are no longer present). This PR changes the output directory to be inside the target directory in the solidity_cargo_tests crate directory.

These output files are opt-in via a RENDER_GRAPHS environment variable. The performance impact of their generation is not too big, but they are generally unnecessary unless we're debugging binding rules.

There are also some tweaks and added information to the .dot file output to improve graph readability and make tracing nodes to rules easier.

@ggiraldez ggiraldez requested a review from a team as a code owner November 27, 2024 00:00
Copy link

changeset-bot bot commented Nov 27, 2024

⚠️ No Changeset found

Latest commit: 4d61ef8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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.

1 participant