Packages

p

org.mulesoft.lsp

textsync

package textsync

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class DidChangeTextDocumentParams(textDocument: VersionedTextDocumentIdentifier, contentChanges: Seq[TextDocumentContentChangeEvent]) extends Product with Serializable

    The document change notification is sent from the client to the server to signal changes to a text document.

    The document change notification is sent from the client to the server to signal changes to a text document.

    textDocument

    The document that did change. The version number points to the version after all provided content changes have been applied.

    contentChanges

    The actual content changes. The content changes describe single state changes to the document. So if there are two content changes c1 and c2 for a document in state S then c1 move the document to S and c2 to S''.

  2. case class DidCloseTextDocumentParams(textDocument: TextDocumentIdentifier) extends Product with Serializable

    The document close notification is sent from the client to the server when the document got closed in the client.

    The document close notification is sent from the client to the server when the document got closed in the client. The document’s truth now exists where the document’s Uri points to (e.g. if the document’s Uri is a file Uri the truth now exists on disk). As with the open notification the close notification is about managing the document’s content. Receiving a close notification doesn't mean that the document was open in an editor before. A close notification requires a previous open notification to be sent. Note that a server’s ability to fulfill requests is independent of whether a text document is open or closed.

    textDocument

    The document that was closed.

  3. case class DidFocusParams(uri: String, version: Integer) extends Product with Serializable
  4. case class DidOpenTextDocumentParams(textDocument: TextDocumentItem) extends Product with Serializable
  5. case class SaveOptions(includeText: Option[Boolean]) extends Product with Serializable

    Save options.

    Save options.

    includeText

    The client is supposed to include the content on save.

  6. case class SynchronizationClientCapabilities(dynamicRegistration: Option[Boolean], willSave: Option[Boolean], willSaveWaitUntil: Option[Boolean], didSave: Option[Boolean]) extends Product with Serializable

    dynamicRegistration

    Whether text document synchronization supports dynamic registration.

    willSave

    The client supports sending will save notifications.

    willSaveWaitUntil

    The client supports sending a will save request and waits for a response providing text edits which will be applied to the document before it is saved.

    didSave

    The client supports did save notifications.

  7. case class TextDocumentContentChangeEvent(text: String, range: Option[Range] = None, rangeLength: Option[Int] = None) extends Product with Serializable

    An event describing a change to a text document.

    An event describing a change to a text document.

    text

    The new text of the range.

    range

    The range of the document that changed.

    rangeLength

    The length of the range that got replaced.

  8. trait TextDocumentSyncConsumer extends InitializableModule[SynchronizationClientCapabilities, Either[TextDocumentSyncKind, TextDocumentSyncOptions]]
  9. case class TextDocumentSyncOptions(openClose: Option[Boolean] = None, change: Option[TextDocumentSyncKind] = None, willSave: Option[Boolean] = None, willSaveWaitUntil: Option[Boolean] = None, save: Option[SaveOptions] = None) extends Product with Serializable

    openClose

    Open and close notifications are sent to the server.

    change

    Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.

    willSave

    Will save notifications are sent to the server.

    willSaveWaitUntil

    Will save wait until requests are sent to the server.

    save

    Save notifications are sent to the server.

Value Members

  1. object TextDocumentSyncConfigType extends ConfigType[SynchronizationClientCapabilities, Either[TextDocumentSyncKind, TextDocumentSyncOptions]] with Product with Serializable
  2. object TextDocumentSyncKind extends Enumeration with Product with Serializable

    Defines how the host (editor) should sync document changes to the language server.

Ungrouped