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

Introduce Kedro viz in VSCode Extension #65

Merged
merged 21 commits into from
Aug 23, 2024
Merged

Introduce Kedro viz in VSCode Extension #65

merged 21 commits into from
Aug 23, 2024

Conversation

jitu5
Copy link
Contributor

@jitu5 jitu5 commented Aug 14, 2024

Description

This PR focus on integrating Kedro Viz into VSCode extension with help of Webview API by VSCode.

How to use

  • Open command palette and type "Run Kedro Viz" and hit enter
  • Clicks on any node from flowchart to navigates to relevant file

Development Notes

Architecture

Screenshot 2024-08-14 at 6 28 34 p m
  • Webview API is used to render Wrapper React App
  • Wrapper React App is used to render Kedro Viz React Component
  • postMessage API is used to communicate between Extension and Webview
  • For file navigation we use combination of existing LSP server and new ts code is used
  • For now, to get Kedro project JSON data we use child_process's exec to run kedro server

Note: TODO:

  • Kedro viz server process not getting killed on deactivate
  • Figure out on autoreload
  • Some more cleanup

User flow

Screenshot 2024-08-14 at 6 35 09 p m

Demo

viz-vsc

jitu5 added 15 commits July 30, 2024 13:30
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5 jitu5 requested a review from noklam August 14, 2024 17:55
@jitu5 jitu5 self-assigned this Aug 14, 2024
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@noklam noklam mentioned this pull request Aug 21, 2024
33 tasks
jitu5 and others added 3 commits August 22, 2024 12:53
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
@noklam noklam merged commit 243c6fe into main Aug 23, 2024
2 checks passed
@noklam noklam deleted the vizwebview branch August 23, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants