官方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
阅读我们的贡献指南
有关详细信息,请参见许可证文件。