Skip to content

Commit 7086e83

Browse files
committed
update readme
1 parent 6173d5f commit 7086e83

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a href="https://marketplace.visualstudio.com/items?itemName=chenglou92.rescript-vscode">ReScript VSCode</a>
33
</h1>
44

5-
<p align="center">The official VSCode plugin for ReScript</p>
5+
<p align="center">The Official VSCode plugin for ReScript</p>
66

77
<p align="center">
88
<a href="https://marketplace.visualstudio.com/items?itemName=chenglou92.rescript-vscode">
@@ -99,8 +99,9 @@ You'll find all ReScript specific settings under the scope `rescript.settings`.
9999

100100
| Setting | Description |
101101
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
102-
| Autostarting ReScript builds | If there's no ReScript build running already in the opened project, the extension will prompt you and ask if you want to start a build automatically. You can turn off this automatic prompt via the setting `rescript.settings.askToStartBuild`. |
102+
| Prompt to Start Build | If there's no ReScript build running already in the opened project, the extension will prompt you and ask if you want to start a build automatically. You can turn off this automatic prompt via the setting `rescript.settings.askToStartBuild`. |
103103
| ReScript Binary Path | The extension will look for the existence of a `/node_modules/.bin/rescript` file and use its directory as the `binaryPath`. If it does not find it at the project root (which is where the nearest `bsconfig.json` resides), it goes up folders in the filesystem recursively until it either finds it (often the case in monorepos) or hits the top level. To override this lookup process, the path can be configured explicitly using the setting `rescript.settings.binaryPath` |
104+
| Inlay Hints (experimental) | This allows an editor to place annotations inline with text to display type hints. Enable using `rescript.settings.inlayHints.enable: true` |
104105
| Autostarting the Code Analyzer | The Code Analyzer needs to be started manually by default. However, you can configure the extension to start the Code Analyzer automatically via the setting `rescript.settings.autoRunCodeAnalysis`. |
105106

106107
**Default settings:**
@@ -114,6 +115,12 @@ You'll find all ReScript specific settings under the scope `rescript.settings`.
114115

115116
// Path to the directory where ReScript binaries are. You can use it if you haven't or don't want to use the installed ReScript from node_modules in your project.
116117
"rescript.settings.binaryPath": null
118+
119+
// Enable (experimental) inlay hints.
120+
"rescript.settings.inlayHints.enable": true
121+
122+
// Maximum length of character for inlay hints. Set to null to have an unlimited length. Inlay hints that exceed the maximum length will not be shown
123+
"rescript.settings.inlayHints.maxLength": 25
117124
```
118125

119126
## 🚀 Code Analyzer

0 commit comments

Comments
 (0)