Skip to content

feat(cli): json/yaml graph renderer#574

Merged
jakobmoellerdev merged 76 commits into
open-component-model:mainfrom
fabianburth:feat/json-or-yaml-tree-renderer
Aug 20, 2025
Merged

feat(cli): json/yaml graph renderer#574
jakobmoellerdev merged 76 commits into
open-component-model:mainfrom
fabianburth:feat/json-or-yaml-tree-renderer

Conversation

@fabianburth

@fabianburth fabianburth commented Aug 15, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

This PR introduces a renderer for lists of objects, rendering them as json or yaml lists:

[
  "A",
  "B",
  "C",
  "D"
]

- A
- B
- C
- D

IMPORTANT:
This implementation would be a breaking change to ocm v1, where json or yaml lists were rendered as:

{
  "items": [
      "A",
      "B",
      "C",
      "D"
  ]
}

A
---
B
---
C
---
D

Considerations:

  • the first one makes it to be parsable more intuitively
  • the first one is the native json/yaml list marshaling

BUT
WILL DEFINITELY break workflows depending on the json or yaml output of the current CLI (if there are any).

It renames the package from renderer to render as it also defines general rendering utilities.
It defines CursorUp and EraseLine itself instead of using the one from the library to make the render package independent of the library.

Which issue(s) this PR fixes

Contributes to open-component-model/ocm-project#563

@github-actions github-actions Bot added kind/feature new feature, enhancement, improvement, extension size/l Large labels Aug 15, 2025
fabianburth and others added 28 commits August 18, 2025 15:25
@fabianburth
feat: add tree renderer
156726a 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: static render children once previous siblings are completed
d1eb6d3 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: refactor graph renderer
5756a76 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: refactor graph renderer to functions
5a95bf8 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: update tree renderer to support multiple roots and improve erro…
b94a57d 
…r handling

Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: revert accidental refactor changes to map test
f9454a8 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: remove component test
d1b97d3 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: adjust comment
e547220 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: split up code into multiple files
5924ee4 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: adjust package name to renamed directory
1d49ef0 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: refactor get neighbors sorted to improve readability
280986a 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: clean up code
d96d104 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
chore: update to updated dag
391b2f0 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@jakobmoellerdev @fabianburth
chore: simplify wait behavior on render loop
49ca49b 
Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
@fabianburth
feat: refactor render functions to be independent of graph, refactor …
4018070 
…package structure and introduce options

Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
fix: linter issues
de41349 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
fix: remove tree filename prefix
fbd3002 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: update names and comments
c1e8784 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: introduce vertex serializer interface as we agreed we want to a…
57e40b1 
…void func fields

Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
chore: incorporate review
a7e5bdb 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
fix: resolve potential overflow
afaef56 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
docs: add comment
4e86914 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
chore: move some more stuff around
8de158d 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
chore: add more documentation
d86fdfd 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@jakobmoellerdev
Merge branch 'main' into feat/tree-renderer
2313e9d
@fabianburth
feat: add tree renderer
d548308 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: static render children once previous siblings are completed
6ad21e9 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: refactor graph renderer
6f0ca41 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
safe intermediate state
802571d 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
store intermediate state
2ae5ead 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
safe intermediate state
952c92b 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
safe intermediate state with mashalizer options
c116f82 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
safe first working state
57e0383 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
safe state with options
845f709 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
safe state after removing component descriptors from tests
2058b95 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: initial version of generic list renderer
a36dabc 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth fabianburth force-pushed the feat/json-or-yaml-tree-renderer branch from f47bdce to a36dabc Compare August 19, 2025 09:53
@fabianburth
feat: tests implemented
86d2066 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: refactor tree renderer test for better readability
9046361 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: rename package
ee78f3c 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
Merge branch 'main' into feat/json-or-yaml-tree-renderer
6fde66d
@fabianburth
feat: remove superseded renderer package
bc147cf 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: move string concatenation into single line
bed2d7c 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
feat: add error to tree vertex serializer
f6557f6 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth fabianburth marked this pull request as ready for review August 19, 2025 13:28
@fabianburth fabianburth requested a review from a team as a code owner August 19, 2025 13:28
@fabianburth fabianburth marked this pull request as draft August 19, 2025 13:39
@fabianburth
feat: add tests for yaml and ndjson
291ca7f 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth fabianburth marked this pull request as ready for review August 19, 2025 13:45
@fabianburth
feat: remove obsolete comment
f9f6663 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth fabianburth self-assigned this Aug 19, 2025
jakobmoellerdev
jakobmoellerdev reviewed Aug 19, 2025
View reviewed changes

@jakobmoellerdev jakobmoellerdev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks neat!

Comment thread cli/internal/render/cmd.go
Comment thread cli/internal/render/graph/list/renderer.go
Comment thread cli/internal/render/graph/list/renderer.go Outdated
Comment thread cli/internal/render/graph/list/renderer.go Outdated
Comment thread cli/internal/render/graph/list/renderer_json_test.go Outdated
Comment thread cli/internal/render/graph/list/renderer_options.go Outdated
Comment thread cli/internal/render/graph/list/renderer_options.go Outdated
@fabianburth
fix: incorporate review
12abd30 
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth
chore: set sleep in test to refresh rate and leverage synctest.Wait()…
202d4d7 
… while adding test case for idempotency

Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@jakobmoellerdev jakobmoellerdev merged commit 536f38d into open-component-model:main Aug 20, 2025
17 checks passed
@jakobmoellerdev

jakobmoellerdev commented Aug 20, 2025

Copy link
Copy Markdown
Member

super nice, cant wait to see it in action

@fabianburth fabianburth deleted the feat/json-or-yaml-tree-renderer branch August 20, 2025 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jakobmoellerdev jakobmoellerdev jakobmoellerdev approved these changes

Assignees

@fabianburth fabianburth

Labels

kind/feature new feature, enhancement, improvement, extension size/l Large

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@fabianburth @jakobmoellerdev