Skip to content

Correct ReScript bindings for signature details #1046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Correct ReScript bindings for signature details #1046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
660f94a
Correct ReScript bindings for signature details
nojaf Oct 24, 2024
7034b0d
Add changelog entries
nojaf Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions tools/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tools/npm/Tools_Docgen.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion tools/npm/Tools_Docgen.resi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion tools/src/tools.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
[
Expand Down
4 changes: 2 additions & 2 deletions tools/tests/src/expected/DocExtraction2.res.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "unit"
}],
Expand Down Expand Up @@ -81,7 +81,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "unit"
}],
Expand Down
4 changes: 2 additions & 2 deletions tools/tests/src/expected/DocExtraction2.resi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "unit"
}],
Expand Down Expand Up @@ -81,7 +81,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "unit"
}],
Expand Down
20 changes: 10 additions & 10 deletions tools/tests/src/expected/DocExtractionRes.res.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "string"
}],
Expand All @@ -73,7 +73,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "t"
}],
Expand All @@ -97,7 +97,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"returnType": {
"path": "int"
}
Expand Down Expand Up @@ -221,7 +221,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "SomeInnerModule.status"
}],
Expand Down Expand Up @@ -317,7 +317,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "unit"
}],
Expand Down Expand Up @@ -365,7 +365,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "t"
}],
Expand Down Expand Up @@ -414,7 +414,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"parameters": [{
"path": "int"
}],
Expand Down Expand Up @@ -450,7 +450,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"returnType": {
"path": "int"
}
Expand Down Expand Up @@ -484,7 +484,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"returnType": {
"path": "int"
}
Expand Down Expand Up @@ -529,7 +529,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"returnType": {
"path": "int"
}
Expand Down
2 changes: 1 addition & 1 deletion tools/tests/src/expected/ModC.res.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"returnType": {
"path": "string"
}
Expand Down
2 changes: 1 addition & 1 deletion tools/tests/src/expected/ModC.resi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"detail":
{
"kind": "signature",
"items": {
"details": {
"returnType": {
"path": "string"
}
Expand Down