earthly.vim's Introduction

Earthfile syntax highlighing

Syntax highlighting for Earthly Earthfiles for Vim.

For an introduction of Earthly see the Earthly GitHub repository or the Earthly documentation.

Requirements

Install vim or neovim
Enable syntax highlighting:

Update your ~/.vimrc file to include:
```
syntax on
```

Installation Notes

Use your favorite plugin manager:

Vim-Plug

Using the vim-plug plugin manager, add:

Plug 'earthly/earthly.vim', { 'branch': 'main' }

Then run

:PlugInstall

Pathogen

git clone [email protected]:earthly/earthly.vim.git ~/.vim/bundle/earthly

Manual

To install manually, copy syntax/Earthfile.vim to ~/.vim/syntax/Earthfile.vim.

Now write the following into the file at ~/.vim/ftdetect/Earthfile.vim

au BufRead,BufNewFile Earthfile set filetype=Earthfile
au BufRead,BufNewFile build.earth set filetype=Earthfile

Neovim

Neovim users will have to change the ~/.vim/ prefix in the above steps to ~/.config/nvim.

Screenshot

earthly.vim's People

Contributors

Stargazers

Watchers

earthly.vim's Issues

tree-sitter

Hey guys,
just a friendly question:
Have you thought about changing this into Tree-sitter parser implementation?
Then it can be used, for example, with Neovim via nvim-treesitter without installing custom plugins. Tree-sitter recently became a de-facto syntax highlighting etc. solution for Neovim.

Unfortunately, I have zero ideas on how to do it and how much work is needed :(

Labels and strings no longer highlighted

Latest version (66bf86d):

Previous version (8f6beb9):

:echo synID(line("."), col("."), 1) says:
0 and 551 respectively

Latest Earthly language keywords not highlighted

Hi team,

Really small nit-pick about the plugin. It looks like the latest new keywords like PROJECT, TRIGGER and PIPELINE haven't been added here for syntax highlighting.

Example using latest plugin version:

Was just using this example from the earthly.dev page for it.

I already made a quick 1-line PR #8 for this, and I ack that an issue probably is overkill but just wanted to document it here in case there was some discussion.

Would be cool (though I'm not really an ANTLR expert) if this could be automated so you didn't have to manually update keywords every time the language definition changed. I guess this is more along the lines of having a more editor agnostic tree-sitter implementation mentioned in #6.

Thanks!

EDIT: I realize this plugin is much much lower priority than VSCode, didn't notice there's already a step of the release process that handles updating VSCode extention which is nice: https://github.com/earthly/earthly/blob/923224f4b5d626c98f4a46d869cc505ce36fc2d9/release/README.md?plain=1#L133

`FUNCTION` not highlighted

Hi there!

I've noticed that FUNCTION is not highlighted since it's a recent addition, would be nice if we can tack it in there.