/vim-terramate

basic vim/terramate integration

Primary LanguageVim ScriptISC LicenseISC

Overview: vim-terramate

This plugin provides the following features:

  • Syntax highlighting for terramate files (*.tm.hcl and *.tm)
  • Language server integration with terramate-ls via vim-lsp
  • :Terramate command that runs terramate, with tab completion of subcommands.
  • Shortcuts:
    • <leader>tm opens documentation of a tm_* function in the web browser

Installation

  • Install vim-plug
    • Install vim-lsp
    • Install vim-terramate
    • Check the "Example vimrc configuration" below if you are using vim-plug for the first time
  • Install terramate-ls
    • go install github.com/terramate-io/terramate/cmd/terramate-ls@latest
    • Ensure terramate-ls is in your $PATH

Example vimrc configuration

call plug#begin('~/.vim/plugged')
Plug 'prabirshrestha/vim-lsp'
Plug 'terramate-io/vim-terramate'
call plug#end()

Usage

Settings are documented in the help.

Running tests

To run the test suite and verify functionality

make

Credits

Syntax highlighting and indentation by Kevin Le (@bkad) based on prior work by Larry Gilbert (@L2G). The rest originally written by Mark Cornick https://www.markcornick.com/ and contributors listed below. Licensed under the ISC license.

Thanks to the following contributors:

  • michael j talarczyk (@mijit)
  • Koji Nakayama (@knakayama)
  • Kris (@kostecky)
  • Okumura Takahiro (@hfm)
  • Paul Forman (@pforman)
  • Lowe Schmidt (@lsc)
  • Mario Kozjak (@mkozjak)