maelvls / vscode-dune

VSCode syntax coloring for Dune/Jbuilder, the OCaml/Reason build system

Dune for vscode

⚠️ Deprecated. Please use the official ocamllabs/vscode-ocaml-platform instead.

Syntax coloring and linting for Dune/Jbuilder files in vscode. It is inspired by the emacs, vim and atom plugins.

This tmLanguage could also be used in other editors (textmate, sublime text) but I didn't write a package/extension specifically for them; feel free to pick the tmLanguage for any other editor! Github source is here.

Contribute

If you to fix the syntax file Dune.tmLanguage, you can use the Dune.YAML-tmLanguage file to do so and then go into build and run

npm install
npm start

to compile yaml into tmLanguage. The JSON-tmLanguage is also generated in case it can help for adding syntax support to an other editor.

To debug the syntax highlighting, you can use the command Developer Tools: Inspect TM Tokens.

vscode-dune's Issues

Comment syntax is wrong?

Dune doesn't understand comments of the form #;. I would suggest always toggling comments with ;.

Mark "dune.inc" as dune file

The file dune.inc is often used as included dune format.

It would be nice to mark it as a dune file.

Add new actions / fields to stanza adding later in the language

Some keywords are missing for dune 2.0, like:

• enabled_ if field in the install stanza and executable stanza
• (no-infer ...) action
• new field (theories ...) to support for theory dependencies and compositional builds
• (subdir ..) stanza to allow evaluating stanzas in sub directories
• list of modifiers that can be nested under with-accepted-exit-codes with chdir, setenv, ignore-<outputs>, with-stdin-from and with-<outputs>-to
• field (optional) for executable stanzas
• deprecated_library_name stanza
• action (with-accepted-exit-codes <pred> <action>)
• (foreign_library ...) stanza as well as the (foreign_stubs ...) and (foreign_archives ...) fields
• alias and package fields in the rule stanza
• formatting stanza
• forbidden_libraries field
• ccomp_type as a variable for evaluating enabled_if
• flag disable_dynamically_linked_foreign_archives to the workspace file

Note: I stopped checking at 1.11.4 or below (see https://github.com/ocaml/dune/releases for details)

Consider making dune the default executable name or fall back to it

The dune name change has been in a for while now. It would be nice not to have to override the dune.path setting to use it. What do you think?