liquidsoap-prettier 1.5.2 → 1.5.4

package/README.md

@@ -17,6 +17,13 @@ It works as follows:
 $ liquidsoap-prettier [-w|--write] path/to/file.liq "path/with/glob/pattern/**/*.liq"
 ```
 
+You can also simply check the script without formatting it:
+```shell
+$ liquidsoap-prettier [-c|--check] path/to/file.liq "path/with/glob/pattern/**/*.liq"
+```
+
+The program returns with exit code `0` when the script is already pretty-printed and `2` otherwise.
+
 ### Prettier plugin
 
 The package also provides a prettier plugin which can be used to add liquidsoap script parsing to
@@ -36,3 +43,19 @@ Then add the plugin to your Prettier config:
   "plugins": ["liquidsoap-prettier"]
 }
 ```
+
+## Developer doc
+
+The code is built using the `prettier` API and a JSON parser exported via `js_of_ocaml` from
+the liquidsoap code.
+
+The JSON parser builtin from liquidsoap code is not commited to this repository. You can download
+it using the `dev:prepare` npm script. For instance:
+
+```shell
+npm run dev:prepare
+```
+
+If you are working on some changes on the liquidsoap language and want to update the parser file, you need
+to install a pinned version of your changes from the liquidsoap code repository using `opam` and then run
+`dune build` inside this repository. This should rebuild the parser file using your latest changes.