Uploaded image for project: 'Kogito'
  1. Kogito
  2. KOGITO-7638

Editor Validation API

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Major Major
    • Kogito Tooling Future
    • None
    • None
    • None
    • Editor Validation API
    • False
    • None
    • False
    • To Do
    • 100% To Do, 0% In Progress, 0% Done
    • ---
    • ---

      At the beginning of the Editor API definitions, we had the vision that each editor would be validating itself, so we created a simple way for editors to provide validation messages to channels, using either the `validate` method on EditorApi, or the Notifications API, to directly interact with the Problems tabs on VS Code and Sandboxes.

       

      With the new Language Service for Serverless Workflow, the job of validating a SWF file became its responsibility was shifted from the Editor (inside Envelopes) to the Language Service (inside Channels). This is due to multiple factors, from separation of concerns, to more complex validations that span across multiple files inside a Workspace.

       

      It's clear though that the Editors (inside Envelopes), still need to work with these validation errors to show a good indication that something's wrong with the file that's being edited.

       

      This Jira proposes a new Editor Validation API to allow Editors inside Envelopes to be aware of such validations. There are several ways to model it, and the implementer should choose what is the best option. (e.g. Notifications, Shared Values, Requests, etc).

       

      We should probably avoid coupling this API with other libraries, like `vscode-languageserver-types`, but the validation messages should have enough information for the Editors to display good visual indications that something's wrong with the file.

              eignatow Eder Ignatowicz
              tfernand-1 Tiago Bento
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: