We switched from VSCode extension to an embedded IDE on app.rakam.io for writing data models so this extension is not maintained anymore. Feel free to fork and maintain the extension if you wish so.
The extension adds support for jsonnet files in VSCode and lets you write the Rakam Recipes in a convenient way.
Syntax highlighting works out of the box. Just open any .jsonnet
or
.libsonnet
file, and it will magically work.
To enable the Jsonnet preview pane, it is necessary to install the
Jsonnet command line tool (e.g., through brew install jsonnet
). If
you don't add the jsonnet
executable to the PATH
then you will
need to customize jsonnet.executablePath
in your settings.json
, so
that the extension knows where to find it.
After this, you can use the keybinding for jsonnet.previewToSide
(by
default this is shift+ctrl+i
, or shift+cmd+i
on macOS), and the
preview pane will open as in the picture above.
This extension exposes the following settings, which can be customized
in settings.json
:
jsonnet.executablePath
: Tells the extension where to find thejsonnet
executable, if it's not on thePATH
. (NOTE: This setting is always necessary on Windows.)jsonnet.libPaths
: Additional paths to search for libraries when compiling Jsonnet code.jsonnet.outputFormat
: Preview output format: yaml or json (default is yaml).jsonnet.extStrs
: External strings to pass tojsonnet
executable.
This extension exposes the following commands, which can be bound to keys:
jsonnet.previewToSide
: Compiles the Jsonnet file to JSON, places result in a "preview" window in the pane to the right of the active pane, or in the current pane if active window is pane 3 (since vscode only allows 3 panes). Default: bound toshift+ctrl+i
(orshift+cmd+i
on macOS).jsonnet.outputFormat
: A choice of two string literals:["json", "yaml"]
. This tells the extension what format you'd like the output to be (i.e., allows you to either output JSON or YAML).