daml/dev-env/dotfiles/README.md
2019-04-04 16:20:07 +02:00

31 lines
951 B
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Editor DAML Language Integration
## Vim
In order to enable vim syntax highlighting for our DSLs, execute the following
two lines in your terminal (assuming `~/dev` is where you've checked out digital-asset/daml)
```
mkdir -p ~/.vim/syntax
ln -s ~/dev/dotfiles/vim/syntax/*.vim ~/.vim/syntax/
```
You also want to make sure that you are sourcing the `.vimrc_da` file in
your `~/.vimrc`.
## VS Code
Follow the DAML Studio installation instructions in the DAML user guide.
## Update Keywords
The instructions on how to update the syntax highlighting of keywords in all our
supported editors is in `pkgs/da-hs-daml-base/src/DA/Daml/ReservedNames.hs`
(see documentation for `printEditorKeywords`).
## Stylish Haskell
Copy the `stylish-haskell.yaml` file either to `~/.stylish-haskell.yaml` or to
`~/dev/.stylish-haskell.yaml`. If you are using vim you can use the plugin
`jasperdvdj/stylish-haskell` to automatically style your code on write.