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

Service Mesh Performance IDE Plugin #379

Open
leecalcote opened this issue May 9, 2023 · 3 comments
Open

Service Mesh Performance IDE Plugin #379

leecalcote opened this issue May 9, 2023 · 3 comments
Labels
issue/design required Design specification needed kind/enhancement New feature or request

Comments

@leecalcote
Copy link
Member

Current Behavior

The objective of this issue is to develop IDE plugins that can enhance the developer experience while working with Service Mesh Performance Performance Profiles. The proposed plugins will leverage technologies such as golang and cuelang to provide features such as syntax highlighting, auto-completion, validation, and rendering previews for Service Mesh Performance profile and model definitions.

Desired Behavior

  1. Release VS Code Extension
  2. Syntax Highlighting and Auto-completion: The plugin can fetch SMP Model definitions such as cloud-native components and their relationships. This information can be used to provide syntax highlighting and auto-completion for these definitions in the JSON files, making it easier for developers to write error-free code.
  3. Validation and Reference: For Meshery MeshModel definitions such as cloud-native components and their relationships, the plugin can use the CUE language to provide validation for the CUE input and preview the rendering result. The plugin can also fetch the SMP Model schemas and display them in the IDE for reference.

Implementation

Acceptance Tests

Mockups


Contributor Guides and Resources

@leecalcote leecalcote added kind/enhancement New feature or request issue/design required Design specification needed labels May 9, 2023
@salsabiilashifa11
Copy link

Hi @leecalcote, my name is Shifa, a final year computer science student from ITB. I have been familiarizing myself with SMP and its implementation within meshery for some time now and I found this project very interesting. I have experience with automata design and language parsing tasks that I think can help me accomplish this project. As an elementary effort to understand this project better, I have made an attempt to put together a simple proposal at https://github.com/salsabiilashifa11/smp-ide-plugin-proposal. Please do take a look :)

I also have some questions:

  1. Is this the right folder to check out to learn more about the Meshery MeshModel definitions that you mentioned in this issue?
  2. What form of rendering result did you have in mind for the preview to be in?

Thank you very much and I hope you have a nice day.

@Azanul
Copy link

Azanul commented May 13, 2023

Hi @salsabiilashifa11, Thank you for showing interest!
The proposal looks quite promising, I'll provide more feedback once I've taken a better look at it.
Answers to your questions:

  1. Yes, it is the folder but it could be a bit difficult to make sense of it all without proper context.

  2. An example of a reference:
    Screenshot 2023-05-14 at 2 19 27 AM

    An example of validation
    Screenshot 2023-05-14 at 2 20 40 AM

Feel free to ask more questions if you need

@leecalcote
Copy link
Member Author

@ShivamCoder23, you might have seen and reviewed this previously. I'll tag you just in case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue/design required Design specification needed kind/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants