Correct ReScript bindings for signature details (#1046)

* Correct ReScript bindings for signature details * Add changelog entries
rescript-lang · Oct 24, 2024 · 90d31cf · 90d31cf
1 parent 61e2709
commit 90d31cf
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 19 deletions.
diff --git a/tools/CHANGELOG.md b/tools/CHANGELOG.md
@@ -12,6 +12,18 @@
 
 ## master
 
+## 0.6.6
+
+### :bug: Bug Fix
+
+- Correct ReScript bindings for signature details. https://github.com/rescript-lang/rescript-vscode/pull/1046
+
+## 0.6.5
+
+#### :rocket: New Feature
+
+- Add additional signature information to doc json. https://github.com/rescript-lang/rescript-vscode/pull/1043
+
 ## 0.6.4
 
 #### :rocket: New Feature

diff --git a/tools/npm/Tools_Docgen.res b/tools/npm/Tools_Docgen.res
@@ -31,7 +31,7 @@ type signatureDetais = {
 type detail =
   | @as("record") Record({items: array<field>})
   | @as("variant") Variant({items: array<constructor>})
-  | @as("alias") Signature(signatureDetais)
+  | @as("alias") Signature({details:signatureDetais})
 
 type source = {
   filepath: string,

diff --git a/tools/npm/Tools_Docgen.resi b/tools/npm/Tools_Docgen.resi
@@ -31,7 +31,7 @@ type signatureDetais = {
 type detail =
   | @as("record") Record({items: array<field>})
   | @as("variant") Variant({items: array<constructor>})
-  | @as("signature") Signature(signatureDetais)
+  | @as("signature") Signature({details:signatureDetais})
 
 type source = {
   filepath: string,

diff --git a/tools/src/tools.ml b/tools/src/tools.ml
@@ -176,7 +176,7 @@ let stringifyDetail ?(indentation = 0) (detail : docItemDetail) =
     stringifyObject ~startOnNewline:true ~indentation
       [
         ("kind", Some (wrapInQuotes "signature"));
-        ( "items",
+        ( "details",
           Some
             (stringifyObject ~startOnNewline:false ~indentation
                [

diff --git a/tools/tests/src/expected/DocExtraction2.res.json b/tools/tests/src/expected/DocExtraction2.res.json
@@ -34,7 +34,7 @@
     "detail": 
     {
       "kind": "signature",
-      "items": {
+      "details": {
       "parameters": [{
           "path": "unit"
         }],
@@ -81,7 +81,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "parameters": [{
             "path": "unit"
           }],

diff --git a/tools/tests/src/expected/DocExtraction2.resi.json b/tools/tests/src/expected/DocExtraction2.resi.json
@@ -34,7 +34,7 @@
     "detail": 
     {
       "kind": "signature",
-      "items": {
+      "details": {
       "parameters": [{
           "path": "unit"
         }],
@@ -81,7 +81,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "parameters": [{
             "path": "unit"
           }],

diff --git a/tools/tests/src/expected/DocExtractionRes.res.json b/tools/tests/src/expected/DocExtractionRes.res.json
@@ -49,7 +49,7 @@
     "detail": 
     {
       "kind": "signature",
-      "items": {
+      "details": {
       "parameters": [{
           "path": "string"
         }],
@@ -73,7 +73,7 @@
     "detail": 
     {
       "kind": "signature",
-      "items": {
+      "details": {
       "parameters": [{
           "path": "t"
         }],
@@ -97,7 +97,7 @@
     "detail": 
     {
       "kind": "signature",
-      "items": {
+      "details": {
       "returnType": {
         "path": "int"
       }
@@ -221,7 +221,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "parameters": [{
             "path": "SomeInnerModule.status"
           }],
@@ -317,7 +317,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "parameters": [{
             "path": "unit"
           }],
@@ -365,7 +365,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "parameters": [{
             "path": "t"
           }],
@@ -414,7 +414,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "parameters": [{
             "path": "int"
           }],
@@ -450,7 +450,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "returnType": {
           "path": "int"
         }
@@ -484,7 +484,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "returnType": {
           "path": "int"
         }
@@ -529,7 +529,7 @@
         "detail": 
         {
           "kind": "signature",
-          "items": {
+          "details": {
           "returnType": {
             "path": "int"
           }

diff --git a/tools/tests/src/expected/ModC.res.json b/tools/tests/src/expected/ModC.res.json
@@ -33,7 +33,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "returnType": {
           "path": "string"
         }

diff --git a/tools/tests/src/expected/ModC.resi.json b/tools/tests/src/expected/ModC.resi.json
@@ -33,7 +33,7 @@
       "detail": 
       {
         "kind": "signature",
-        "items": {
+        "details": {
         "returnType": {
           "path": "string"
         }