VS Code Extension: Architecture improvements - Milestone 1

[eburnette]

VS Code Extension: Architecture improvements - Milestone 1

Description

This PR is for issue #3

Milestone 1 describes the planned architecture changes. It contains no code.

Submission Links & Documents

N/A

Requirements Check

• Have have you met the milestone requirements? YES
• Have you included tests (if applicable)? N/A
• Have you met the contribution guidelines of the repos you have submitted code to (if applicable)? N/A

Other Details

• Is there anything specific you'd like the PoC to know or review for? NO
• Are there other references, documentation, or relevant artificats to mention for this PR (ie. external links to justify design decisions, etc.)? NO

[sideninja]

Should this be converted to draft if it's still WIP?

[eburnette]

It's complete unless there are comments that require changes.

[psiemens]

This looks good to me, thanks @eburnette!

I'll let @sideninja weigh in too, but you're good to proceed to milestone 2.

[psiemens]

Merged @eburnette!

[sideninja]

Hi, @eburnette I overlooked this document as I thought it is linking the PR on the vscode.
I think your plan looks solid, the only concern I have is about extracting the flowkit to a separate repository, although I agree this is a good decision down the line I don't think it is mature enough to be treated as a separate component, reasons being as soon as we extract it and advertise it as a package to be used by others we need to take extra care with changes in the API as for now it is more of a draft version and after we learn what is the best API from the LS and other implementations we can then think about extracting it. This extraction should it happen as part of this task it should be part of extra features in the end and we need to discuss documentation, API design, etc. But I agree 100% and my plan was too to extract it at some point, I just don't feel the API is mature enough. cc @psiemens

[eburnette]

@sideninja will there be any problem with the extension reaching into the cli project to get flowkit? If not, then I agree the repo change can wait.

[sideninja]

@eburnette no problem at all, in fact there is already flowkit used in the LS