ReaSyntax in Vim!

Drawing some inspiration from the lovely ReaSyntax project in Sublime Text, this is a plugin that provides functions for generating UltiSnips snippets for all languages straight from the official REAPER ReaScript API.

* GIF also features vim-eel for EEL syntax/indentation

Installation

Add this to your favourite plugin manager like vim-plug as such:

Plug 'NlGHT/vim-reasyntax'

This requires UltiSnips to be installed to do anything!

You probably also want to install YouCompleteMe or another plugin that provides autocomplete suggestions from UltiSnips for the full effect!

Usage

The easiest way to use Vim-ReaSyntax is to configure it with your .vimrc with the options you want as such:

let g:reasyntax_languages = 'elc' " available: 'elcp', default: ''
let g:reasyntax_delete_unused_languages = 1 " default: 1
let g:reasyntax_silent = 0 " default: 0

• g:reasyntax_languages is for specifying the languages to sync snippets for by first letter denoting each. So if you wanted just EEL2 and Lua you would do: = 'el' and just CPP would be = 'c'. Default is none ('').
• g:reasyntax_delete_unused_languages is an option to delete the snippet files for languages not in the synced languages. Default is on (1).
• g:reasyntax_silent is an option if you don't want any noise. Turning off will result in no printing. Maybe useful if you have everything setup and want to set and forget. Default is off (0).

Only g:reasyntax_languages is required for syncing via config. Omitting any others will just use their default values.

After snippets have been generated you will need to restart vim or reload the snippets in UltiSnips another way.

Updating Snippets

Currently there are the following commands:

• :ReaSyntaxUpdateEEL
• :ReaSyntaxUpdateLua
• :ReaSyntaxUpdateCPP
• :ReaSyntaxUpdatePython
• :ReaSyntaxUpdateAll

These are available to run from anywhere and will generate the corresponding language snippets, overwriting current snippets (equivalent of updating). For UltiSnips to then load them, you must restart vim.

No Syntax/Indentation Files?

Due to there being so many languages supported with vim, no syntax files have been added here to avoid conflicts people will experience from those other implementations.

However here are projects you will likely want for the respective languages missing:

vim-eel

This plugin provides everything for working with EEL2 (also made by me!) including proper, good syntax and indentation files. These are made from the ground up (none of the terrible ones that try to just use one for C!).

vim-polyglot

This is a large language pack that many people likely already have installed to extend the supported languages in vim. This for example provides Lua support!

If you just want Lua there is also vim-lua and vim-lua-ftplugin.

Contributing

All contributions are very welcome! Thanks for taking an interest in adding to the project! Currently there are a few small things to look out for so we can all get along nicely! :):

• Everything in the file python/ReaSyntax.py should be fully self-contained to just handling the API parsing.
• Everything in the file plugin/ReaSyntax.vim should handle everything related to the vim plugin specifically.
• Prefix everything pertaining to the plugin locally with s: as is done with everything currently in there (such as s:plugin_root_dir or s:ReaSyntaxUpdateLua())

Missing Features

• No support for the {reaper.array}.methods() as I'm not sure the best way to implement them yet in terms of usability and co-operating with UltiSnips. Please let me know any suggestions you have!
• No snippets are distributed. This is intentional for now as it keeps things up-to-date and allows the user to disable and enable language snippets (by deleting and creating them) with their config whenever they want. It also means people don't have to download languages they have no interest in using. If this becomes higher demand, a method could maybe be developed.
• There is NO LSP! There is no code checking and these things are also not the goal of this project. This project (and vim-eel) are modular, adhering to the unix philosophy and they can and will still exist alongside any LSP project that is developed. All this project does is convert the REAPER ReaScript API into UltiSnips snippets. Only requirement is it needs to do it well! :)