<a id="vim"></a>

# Vim

We have created a [Vim](https://www.vim.org) plugin to make it easier to work with our [configuration](config.html.md).
It provides syntax highlighting, indentation and completion for the Halon [script](https://docs.halon.io/hsl/) (HSL) source files.

> > **Note**
> > 
> > For a more fully-featured integration that supports [linting](vscode.html.md#vscode-linter) and [debugging](vscode.html.md#vscode-debug)
> > right inside the code editor, see our [Visual Studio Code integration](vscode.html.md) instead.

<a id="features"></a>

## Features

* Syntax highlighting
* Indentation
* Completion
  * Covers the entire standard library

<a id="installation"></a>

## Installation

To install the plugin use the following command.

```console
$ git clone https://github.com/halon/vim-hsl.git ~/.vim/pack/vendor/start/vim-hsl
```

To enable it add the following to your `~/.vimrc` file.

```default
syntax on
filetype plugin indent on
```

<a id="upgrade"></a>

### Upgrade

In order to upgrade the plugin, use the following command.

```console
$ git -C ~/.vim/pack/vendor/start/vim-hsl pull
```

<a id="screenshots"></a>

## Screenshots

![image](_images/vim-1.png)

*The Halon [script](https://docs.halon.io/hsl/) (HSL) syntax highlighting and completion in action*

![image](_images/vim-2.png)

*Linting a script hook in a Vim window with `:terminal halonconfig`*