ah-yu / rescript-vscode

Official VSCode plugin for ReScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ReScript VSCode

The Official VSCode plugin for ReScript

Contents

πŸ“ Prerequisite

You must have ReScript >= 9.1 installed locally in your project, through the usual npm or yarn installation. Older versions are not guaranteed to work.

🌈 Supported Themes

Our highlighting works well with most popular VSCode themes, such as:

  • Dark+ (default dark), Light+ (default light)
  • Solarized Dark, Solarized Light
  • Monokai Dimmed
  • Tomorrow Night Blue
  • One Dark Pro

The only 2 themes we don't (and can't) support, due to their lack of coloring, are:

  • Dark (Visual Studio), Light (Visual Studio)

Note If your custom theme doesn't seem to highlight much (e.g. no colors for upper-case JSX tag, no distinction between module and variant), try one of the recommended themes to see if that's the problem. For more info, see this post.

πŸ’‘ Features

  • Supports .res, .resi and bsconfig.json.
  • Syntax highlighting.
  • Formatting.
  • Build diagnostics.
  • Built-in bsb watcher (optional, and exposed explicitly as a pop-up; no worries of dangling build).
  • Type hint hover.
  • Jump to definition.
  • Autocomplete.
  • Find references.
  • Rename.
  • Inlay Hints.
  • Signature help.
  • Code lenses.
  • Snippets to ease a few syntaxes:
    • external features such as @bs.module and @bs.val
    • try, for, etc.
  • Folding, and custom folding through //#region and //#endregion.

πŸ“₯ Installation

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

ext install chenglou92.rescript-vscode

The plugin activates on .res and .resi files. If you've already got Reason-Language-Server installed, it's possible that the latter took precedence over this one. Make sure you're using this plugin ("ReScript syntax") rather than Reason-Language-Server ("BuckleScript syntax").

Pre-release channel

There is a pre-release channel available. It is intended for testing new and therefore possibly unstable features. You can activate it by clicking on the "Switch to Pre-Release Version" button on the rescript-vscode extension page in VSCode. From this point on, pre-release versions will always have an odd version minor (1.5.x, 1.7.x, 2.1.x, etc.) while stable releases have even version minor numbers (1.4.x, 1.6.x, 2.0.0, etc.).

Even if the pre-release channel seems too experimental to you, we still suggest you to give it a try and submit any issues that you run into. In the long run it will give us a better editor experience overall.

πŸ“¦ Commands

Command Description
ReScript: Create an interface file for this implementation file Creates an interface file (.resi) for the current .res file, automatically filling in all types and values in the current file.
ReScript: Open the compiled JS file for this implementation file Opens the compiled JS file for the current ReScript file.
ReScript: Switch implementation/interface Switches between the implementation and interface file. If you're in a .res file, the command will open the corresponding .resi file (if it exists), and if you're in a .resi file the command will open the corresponding .res file. This can also be triggered with the keybinding Alt+O.
ReScript: Start Code Analyzer This will start code analysis in the ReScript project of the file you run the command from.

πŸ”¨ Settings

You'll find all ReScript specific settings under the scope rescript.settings.

Setting Description
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.
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
ReScript Platform Path The extension will look for the existence of a node_modules/rescript directory and use the subdirectory corresponding to the current platform as the platformPath. 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.platformPath
Inlay Hints (experimental) This allows an editor to place annotations inline with text to display type hints. Enable using rescript.settings.inlayHints.enable: true
Code Lens (experimental) This tells the editor to add code lenses to function definitions, showing its full type above the definition. Enable using rescript.settings.codeLens: true
Signature Help (experimental) This tells the editor to show signature help when you're writing function calls. Enable using rescript.settings.signatureHelp.enable: true
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.

Default settings:

// 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,

// Automatically start ReScript's code analysis.
"rescript.settings.autoRunCodeAnalysis": false,

// 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

πŸš€ Code Analyzer

The Code Analyzer is a mode in the extension that runs additional code analysis in your project. The analysis helps you find dead code at a granular level, find unhandled exceptions, and more.

The Code Analyzer uses reanalyze, which is embedded in the extension, so you don't need to install anything extra to run it.

Configuring the Code Analyzer

You'll need to configure what code analysis you want to run, and what (if any) directories you want to ignore. Configuration is done via adding reanalyze in bsconfig.json. You'll get autocomplete for what configuration options are valid. You can also read all about configuring reanalyze here.

Usage

Open the command palette and run ReScript: Start Code Analyzer. This will start code analysis in the ReScript project of the file you run the command from.

Dead code is highlighted in the editor, and code actions for suppressing dead code warnings are available in most cases.

When done, stop the code analysis mode by clicking the Stop Code Analyzer button in the editor status bar. This will clear all reported analysis warnings.

Caveats

Currently does not work for full monorepo dead code analysis (although it should work for each monorepo package individually).

πŸͺ„ Tips & Tricks

Hide generated files

You can configure VSCode to collapse the JavaScript files ReScript generates under its source ReScript file. This will "hide" the generated files in the VSCode file explorer, but still leaving them accessible by expanding the source ReScript file they belong to.

Open your VSCode settings and type:

"explorer.fileNesting.enabled": true,
"explorer.fileNesting.patterns": {
  "*.res": "${capture}.mjs, ${capture}.js, ${capture}.cmi, ${capture}.cmt, ${capture}.cmj",
  "*.resi": "${capture}.res"
},

This nests implementations under interfaces if they're present and nests all generated files under the main ReScript file. Adapt and tweak to your liking.

A screenshot of the result:

Shows the end result in VSCode, with ReScript related files nested under eachother appropriately.

⌨️ Use with Other Editors

This repo also contains a language server that can power other editors. However, the language server in this project is a pure implementation detail. We don't guarantee its stability for other editors' consumption apart from Vim and Sublime Text.

Still, if you'd like to use this language-server with other editors:

  • Get the release binaries from the Github Releases page.
  • Unzip the .vsix and get the server folder. That's the only folder you need.
  • The language server will be at server/out/server.js. Call it through node, and optionally pass --stdio if your editor doesn't support the default JSONRPC.

πŸ“° Changelog

See CHANGELOG

πŸ‘ How to Contribute

Read our Contributing Guide

πŸ“„ License

See the LICENSE file for details.

About

Official VSCode plugin for ReScript

License:MIT License


Languages

Language:ReScript 57.5%Language:OCaml 34.8%Language:TypeScript 7.3%Language:Shell 0.2%Language:Makefile 0.1%Language:JavaScript 0.1%Language:Rust 0.0%Language:Standard ML 0.0%Language:Reason 0.0%