From 7ee2d4b768bf19ba98ce7fcaf5efe9426c508825 Mon Sep 17 00:00:00 2001 From: Marcin Jekot Date: Sun, 26 May 2019 16:57:52 +0200 Subject: [PATCH] Update README, to install ocp-indent / refmt I was recently bitten by this: I had `editor.formatOnSave` enabled, but I didn't know I needed to install `ocp-indent`. The plugin crashes, and it's quite difficult to troubleshoot. Before #269 gets merged and released, can we update the README, to help others who might hit this. related #142 fixes #247 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9d90e50..05bf03e 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,8 @@ To enable formatting on save, add the following to `Code > Preferences > Setting } ``` +For formatting, make sure you have `ocp-indent` (for OCaml) and `refmt` (for ReasonML), installed and available in your `PATH`, otherwise this extension will currently crash ([issue](#142)). + If you want to enable [codelens](https://code.visualstudio.com/blogs/2017/02/12/code-lens-roundup), add the following to `Code > Preferences > Settings`: ``` "reason.codelens.enabled": true