feat: add MarkupContent and TextDocumentSyncOptions (#5)

Fixes #4

Fix typos (detected by codespell, should have already been fixed in specification document)
remove unused use statements (detected by Phan)

Author: TysonAndre

src/CompletionItem.php

@@ -3,8 +3,6 @@
 
 namespace LanguageServerProtocol;
 
-use LanguageServer\Definition;
-
 class CompletionItem
 {
     /**
@@ -40,7 +38,7 @@ class CompletionItem
     public $documentation;
 
     /**
-     * A string that shoud be used when comparing this item
+     * A string that should be used when comparing this item
      * with other items. When `falsy` the label is used.
      *
      * @var string|null

src/DocumentHighlightKind.php

@@ -8,7 +8,7 @@
 abstract class DocumentHighlightKind
 {
     /**
-     * A textual occurrance.
+     * A textual occurrence.
      */
     const TEXT = 1;
 

src/Hover.php

@@ -10,7 +10,7 @@ class Hover
     /**
      * The hover's content
      *
-     * @var string|MarkedString|string[]|MarkedString[]
+     * @var string|MarkedString|string[]|MarkedString[]|MarkupContent
      */
     public $contents;
 

src/Location.php

@@ -2,9 +2,6 @@
 
 namespace LanguageServerProtocol;
 
-use Microsoft\PhpParser;
-use Microsoft\PhpParser\Node;
-
 /**
  * Represents a location inside a resource, such as a line inside a text file.
  */

src/MarkupContent.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace LanguageServerProtocol;
+
+/**
+ * A `MarkupContent` literal represents a string value which content is interpreted base on its
+ * kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
+ *
+ * If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
+ * See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+ *
+ * Here is an example how such a string can be constructed using JavaScript / TypeScript:
+ * ```ts
+ * let markdown: MarkdownContent = {
+ *  kind: MarkupKind.Markdown,
+ *  value: [
+ *      '# Header',
+ *      'Some text',
+ *      '```typescript',
+ *      'someCode();',
+ *      '```'
+ *  ].join('\n')
+ * };
+ * ```
+ *
+ * *Please Note* that clients might sanitize the return markdown. A client could decide to
+ * remove HTML from the markdown to avoid script execution.
+ */
+class MarkupContent
+{
+    /**
+     * @var string the type of the Markup (from MarkupKind)
+     */
+    public $kind;
+
+    /**
+     * @var string the content itself
+     */
+    public $value;
+
+    /**
+     * @param string $kind the type of the Markup
+     * @param string $value the content itself
+     */
+    public function __construct(string $kind = null, string $value = null)
+    {
+        $this->kind = $kind;
+        $this->value = $value;
+    }
+}

src/MarkupKind.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace LanguageServerProtocol;
+
+/**
+ * Describes the content type that a client supports in various
+ * result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
+ *
+ * Please note that `MarkupKinds` must not start with a `$`. This kinds
+ * are reserved for internal usage.
+ */
+abstract class MarkupKind
+{
+    /**
+     * Plain text is supported as a content format
+     */
+    const PLAINTEXT = 'plaintext';
+
+    /**
+     * Markdown is supported as a content format
+     */
+    const MARKDOWN = 'markdown';
+}

src/Range.php

@@ -2,9 +2,6 @@
 
 namespace LanguageServerProtocol;
 
-use Microsoft\PhpParser;
-use Microsoft\PhpParser\Node;
-
 /**
  * A range in a text document expressed as (zero-based) start and end positions.
  */

src/SaveOptions.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace LanguageServerProtocol;
+
+/**
+ * Options controlling what is sent to the server with save notifications.
+ */
+class SaveOptions
+{
+    /**
+     * The client is supposed to include the content on save.
+     * @var bool|null
+     */
+    public $includeText;
+}

src/ServerCapabilities.php

@@ -7,7 +7,7 @@ class ServerCapabilities
     /**
      * Defines how text documents are synced.
      *
-     * @var int|null
+     * @var TextDocumentSyncOptions|int|null
      */
     public $textDocumentSync;
 

src/SymbolInformation.php

@@ -2,9 +2,6 @@
 
 namespace LanguageServerProtocol;
 
-use Microsoft\PhpParser;
-use Microsoft\PhpParser\Node;
-
 /**
  * Represents information about programming constructs like variables, classes,
  * interfaces etc.