Merge pull request #21 from zobo/fix-signature-help

fix: signature help must not send null fields

Author: muglug

.gitattributes

@@ -1,4 +1,4 @@
-* text=auto
+* text=auto eol=lf
 
 /.gitattributes export-ignore
 /.gitignore export-ignore

.github/workflows/semantic.yml

@@ -0,0 +1,25 @@
+name: 'Semantic Pull Request'
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+#  pull_request:
+#    types:
+#      - opened
+#      - edited
+#      - synchronize
+
+jobs:
+  main:
+    name: Validate PR Title
+    runs-on: ubuntu-latest
+    steps:
+      - name: semantic-pull-request
+        uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          validateSingleCommit: false

src/ParameterInformation.php

@@ -2,11 +2,13 @@
 
 namespace LanguageServerProtocol;
 
+use JsonSerializable;
+
 /**
  * Represents a parameter of a callable-signature. A parameter can
  * have a label and a doc-comment.
  */
-class ParameterInformation
+class ParameterInformation implements JsonSerializable
 {
     /**
      * The label of this parameter information.
@@ -42,4 +44,16 @@ public function __construct($label, $documentation = null)
         $this->label = $label;
         $this->documentation = $documentation;
     }
+
+    /**
+     * This is needed because VSCode Does not like nulls
+     * meaning if a null is sent then this will not compute
+     *
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this));
+    }
 }

src/SignatureHelp.php

@@ -2,12 +2,14 @@
 
 namespace LanguageServerProtocol;
 
+use JsonSerializable;
+
 /**
  * Signature help represents the signature of something
  * callable. There can be multiple signature but only one
  * active and only one active parameter.
  */
-class SignatureHelp
+class SignatureHelp implements JsonSerializable
 {
     /**
      * One or more signatures. If no signatures are available the signature help
@@ -58,4 +60,18 @@ public function __construct(array $signatures = null, $activeSignature = null, i
         $this->activeSignature = $activeSignature;
         $this->activeParameter = $activeParameter;
     }
+
+    /**
+     * This is needed because VSCode Does not like nulls
+     * meaning if a null is sent then this will not compute
+     *
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this), function ($v) {
+            return $v !== null;
+        });
+    }
 }

src/SignatureHelpClientCapabilities.php

@@ -2,7 +2,9 @@
 
 namespace LanguageServerProtocol;
 
-class SignatureHelpClientCapabilities
+use JsonSerializable;
+
+class SignatureHelpClientCapabilities implements JsonSerializable
 {
     /**
      * Whether signature help supports dynamic registration.
@@ -40,4 +42,18 @@ public function __construct(
         $this->signatureInformation = $signatureInformation;
         $this->contextSupport = $contextSupport;
     }
+
+    /**
+     * This is needed because VSCode Does not like nulls
+     * meaning if a null is sent then this will not compute
+     *
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this), function ($v) {
+            return $v !== null;
+        });
+    }
 }

src/SignatureHelpOptions.php

@@ -2,10 +2,12 @@
 
 namespace LanguageServerProtocol;
 
+use JsonSerializable;
+
 /**
  * Signature help options.
  */
-class SignatureHelpOptions
+class SignatureHelpOptions implements JsonSerializable
 {
     /**
      * The characters that trigger signature help automatically.
@@ -21,4 +23,16 @@ public function __construct(array $triggerCharacters = null)
     {
         $this->triggerCharacters = $triggerCharacters;
     }
+
+    /**
+     * This is needed because VSCode Does not like nulls
+     * meaning if a null is sent then this will not compute
+     *
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this));
+    }
 }

src/SignatureInformation.php

@@ -2,12 +2,14 @@
 
 namespace LanguageServerProtocol;
 
+use JsonSerializable;
+
 /**
  * Represents the signature of something callable. A signature
  * can have a label, like a function-name, a doc-comment, and
  * a set of parameters.
  */
-class SignatureInformation
+class SignatureInformation implements JsonSerializable
 {
     /**
      * The label of this signature. Will be shown in
@@ -63,4 +65,18 @@ public function __construct(
         $this->documentation = $documentation;
         $this->activeParameter = $activeParameter;
     }
+
+    /**
+     * This is needed because VSCode Does not like nulls
+     * meaning if a null is sent then this will not compute
+     *
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this), function ($v) {
+            return $v !== null;
+        });
+    }
 }