User Guide

Everything you need to get started with the ReScript IntelliJ Plugin and make the most of its features.

Getting Started

• Installation — Install the plugin and set up the Language Server

• Quick Start — Your first steps with ReScript in a JetBrains IDE

• Migrating from VSCode — Shortcut mapping and feature comparison

• ReScript Basics — Setting up a ReScript project from scratch

Features

• Feature Overview — All features at a glance

• Syntax Highlighting — Lexer-based and semantic highlighting

• Code Completion — Intelligent completions via LSP

• Navigation — Go to Definition, Symbol, Related files

• Code Editing — Folding, formatting, intentions, surround

• Run & Build — Run configurations and build status

• Testing — Test runner integration (Jest/Vitest)

• Code Analysis — Inspections, dead code analysis, import optimization

• Advanced Features — Code Lens, Compiled JS Preview, Module Hierarchy

Project Templates

• Project Templates — Scaffold production-shaped ReScript projects from the New Project wizard

Recipes

• Recipe Collection — Task-oriented guides for common workflows

Reference

• Quick Reference Card — Condensed cheat sheet of shortcuts and features

• Keymap Visualizer — Interactive keyboard layout with shortcut overlays

• Settings Generator — Build a custom plugin configuration JSON

• Version Matrix — Features by version and IDE compatibility

• Configuration — Plugin settings

• Keyboard Shortcuts — Shortcut reference

• FAQ — Frequently asked questions

• Troubleshooting — Common issues and solutions

• Glossary — Key terms and definitions

• Changelog — Release notes