官方VSCODE插件

您必須通過通常的NPM或紗線安裝在項目中本地安裝reccript> = 9.1。舊版本不能保證工作。
我們的突出顯示與最流行的VSCODE主題相當良好,例如:
由於缺乏著色,我們唯一沒有(也不能)支持的兩個主題是:
請注意,如果您的自定義主題似乎並沒有突出顯示(例如,上案例JSX標籤沒有顏色,模塊和變體之間沒有區別),請嘗試使用推薦的主題之一,看看是否是問題。有關更多信息,請參閱此帖子。
.res , .resi , rescript.json和舊版配置文件bsconfig.json 。external功能,例如@bs.module和@bs.valtry , for等。//#region和//#endregion進行自定義折疊。 啟動VS代碼快速打開( Ctrl+P ),粘貼以下命令,然後按Enter。
ext install chenglou92.rescript-vscode
該插件在.res和.resi文件上激活。如果您已經安裝了理性語言服務器,那麼後者可能優先於此。確保您使用此插件(“ reccript語法”),而不是理性語言 - 詞組(“ bucklescript語法”)。
有一個預發行頻道可用。它旨在測試新的,因此可能是不穩定的功能。您可以通過單擊VSCODE中的rescript-vscode擴展頁面上的“開關為釋放版本”按鈕來激活它。從這一點上開始,預釋放版本將始終具有零件版本的次要版本(1.5.x,1.7.x,2.1.x等),而穩定的版本甚至具有次要版本的次要版本(1.4.x,1.6.x,1.6.x,2.0.0等)。
即使預發行頻道對您來說似乎太實驗了,我們仍然建議您嘗試一下並提交遇到的任何問題。從長遠來看,它將為我們提供更好的編輯體驗。
| 命令 | 描述 |
|---|---|
| reccript:為此實現文件創建一個接口文件 | 為當前.res文件創建一個接口文件( .resi ),自動填充當前文件中的所有類型和值。 |
| reccript:為此實現文件打開編譯的JS文件 | 為當前的reccript文件打開編譯的JS文件。 |
| reccript:Switch實現/接口 | 在實現和接口文件之間進行切換。如果您在.res文件中,則命令將打開相應的.resi文件(如果存在),如果您在.resi文件中,則命令將打開相應的.res文件。這也可以使用鑰匙限制Alt+O觸發。 |
| reccript:開始代碼分析儀 | 這將在您從您運行的命令的文件的reccript項目中啟動代碼分析。 |
您會在示波器rescript.settings下找到所有特定於RESCRIPT的設置。
| 環境 | 描述 |
|---|---|
| 提示開始構建 | 如果在打開的項目中沒有運行的reccript構建,則擴展程序將提示您並詢問您是否要自動啟動構建。您可以通過設置rescript.settings.askToStartBuild關閉此自動提示。 |
| reccript二進制路徑 | 擴展程序將尋找node_modules/.bin/rescript文件的存在,並將其目錄用作binaryPath 。如果它找不到項目根部(這是最近的rescript.json居住的地方),則它會遞歸地沿文件夾上升到文件夾,直到它找到它(通常是monorepos中的情況)或達到頂級級別。為了覆蓋此查找過程,可以使用設置rescript.settings.binaryPath Path對路徑進行明確配置 |
| 復位平台路徑 | 該擴展名將尋找node_modules/rescript目錄的存在,並使用與當前平台相對應的子目錄作為platformPath 。如果它找不到項目根部(這是最近的rescript.json居住的地方),則它會遞歸地沿文件夾上升到文件夾,直到它找到它(通常是monorepos中的情況)或達到頂級級別。為了覆蓋此查找過程,可以使用設置rescript.settings.platformPath明確配置該路徑 |
| 鑲嵌提示(實驗) | 這允許編輯器將帶有文本的註釋在顯示類型提示中。啟用使用rescript.settings.inlayHints.enable: true |
| 代碼鏡頭(實驗) | 這告訴編輯器將代碼鏡頭添加到函數定義中,顯示其完整類型以上定義。啟用使用rescript.settings.codeLens: true |
| 簽名幫助 | 這告訴編輯器在編寫功能調用時顯示簽名幫助。啟用使用rescript.settings.signatureHelp.enabled: true |
默認設置:
// Whether you want the extension to prompt for autostarting a ReScript build if a project is opened with no build running
"rescript.settings.askToStartBuild" : true ,
// Path to the directory where cross-platform 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.
"rescript.settings.binaryPath" : null
// Path to the directory where platform-specific 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.
"rescript.settings.platformPath" : null
// Enable (experimental) inlay hints.
"rescript.settings.inlayHints.enable" : true
// 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
"rescript.settings.inlayHints.maxLength" : 25
// Enable (experimental) code lens for function definitions.
"rescript.settings.codeLens" : true 代碼分析儀是擴展程序中的一種模式,可在項目中運行其他代碼分析。該分析可幫助您在顆粒狀的層面找到死亡代碼,查找未經治療的例外等等。
代碼分析儀使用嵌入在擴展中的Reanalyze,因此您無需安裝任何額外的操作即可運行它。
您需要配置要運行的代碼分析以及要忽略的目錄(如果有)。配置是通過在rescript.json中添加reanalyze來完成的。對於哪些配置選項有效,您將獲得自動完成。您也可以在此處閱讀有關配置reanalyze所有內容。
打開命令調色板並運行ReScript: Start Code Analyzer 。這將在您從您運行的命令的文件的reccript項目中啟動代碼分析。
編輯器中突出顯示了死亡代碼,並且在大多數情況下都可以使用用於抑制死亡代碼警告的代碼操作。
完成後,通過單擊編輯器狀態欄中的Stop Code Analyzer按鈕來停止代碼分析模式。這將清除所有報告的分析警告。
目前不適用於完整的MonorePo死亡代碼分析(儘管它應該單獨適用於每個MonorePo軟件包)。
您可以配置VSCODE以折疊JavaScript文件reccript在其源代碼reccript文件下生成。這將“隱藏” Vscode文件資源管理器中生成的文件,但仍可以通過擴展其屬於其屬於的源代碼的文件來訪問它們。
打開您的VSCODE設置並輸入:
"explorer.fileNesting.enabled" : true ,
"explorer.fileNesting.patterns" : {
"*.res" : "${capture}.mjs, ${capture}.js, ${capture}.cmi, ${capture}.cmt, ${capture}.cmj" ,
"*.resi" : "${capture}.res"
} ,如果它們存在,則將其嵌套在接口下的實現,並將所有生成的文件嵌套在主reccript文件下。適應您的喜好。
結果的屏幕截圖:

請參閱ChangElog
閱讀我們的貢獻指南
有關詳細信息,請參見許可證文件。