README.md

Vim Just Syntax

Vim syntax files for justfiles.

Works with Vim/GVim >= 8, Neovim >= 0.4.

Installation

Vim8 Package

cd ~/.vim/pack/YOUR-NAMESPACE-HERE/start/
git clone https://github.com/NoahTheDuke/vim-just.git

With a plugin manager

vim-plug

Plug 'NoahTheDuke/vim-just'

lazy.nvim

{
  "NoahTheDuke/vim-just",
  ft = { "just" },
}

Third-party packages

For questions or issues when using these packages, contact the package's maintainer.

Using alongside nvim-treesitter

If nvim-treesitter is installed and has a justfile language parser available, nvim-treesitter will overrule vim-just by default.

To use vim-just syntax highlighting with other nvim-treesitter features, configure nvim-treesitter not to use its justfile language parser for syntax highlighting:

require("nvim-treesitter.configs").setup({
  highlight = {
    enable = true,
    disable = { "just" },
  },
})

For more details or more complex configurations, see nvim-treesitter documentation.

Migrating old git clone based installations to main

In late March 2023, development was moved from master branch to main branch, and master is no longer maintained. Updating installations that used a git clone prior to these changes requires some additional one-time steps:

git fetch
git checkout main
git branch -d master || git branch --unset-upstream master
git remote set-head origin -a
git remote prune origin

Now future updates can again be obtained normally.

Contributing & Development

See CONTRIBUTING.md.