openrewrite / openrewrite/rewrite-analysis

Control Flow Visualization generated as comment as opposed to new stand alone file

Open
#69 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
16
Forks
12
Avg merge
2h 26m
Merged PRs (30d)
1

Description

Dot file is not generated while running the Control Flow Visualization recipe.

After running the recipe, it is adding the diagraph notations to the class but the dot file is not generated.

Have tried with both includeDotfile as true & false, but not generating the file. When includeDotfile is true, its adding diagraph notions and when false, it is not added.

Do we need to use a separate recipe to generate the dot file from the notations added by the recipe ?

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ControlFlowVisualizationExample
displayName: Control Flow Visualization example
recipeList:
  - org.openrewrite.analysis.controlflow.ControlFlowVisualization:
      includeDotfile: true

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the Control Flow Visualization recipe from the supplied YAML with includeDotfile set to true and false, then inspect whether the class receives graph annotations and whether a standalone dot file is created. Review the recipe's documented output and determine the expected behavior for both settings; done means the configured dot-file behavior is consistent and covered by a reproducible test.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.