Skip to content

Write VIM plugins in JavaScript, powered by Electron

Notifications You must be signed in to change notification settings

bryphe/vim-electrify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Stories in Ready

vim-electrify

Write VIM plugins in JavaScript, powered by Electron

Intro

vim-electrify is a VIM plugin that enables the authoring of JavaScript plugins, running in a Node/Electron environment.

vim-electrify-demo

That shows some basic functionality in the API - both receiving messages and sending messages to VIM. The real power of this, though, is writing plugins in JavaScript - and leveraging all the rich debugging tools that are available in that ecosystem.

Plugins

Plugins built with vim-electrify

Installation

Currently, this plugin is only tested on Windows 10, with Vim. It should be relatively straightforward to make it work on OS X, however there will likely be some fixes required.

Prerequisites

Other requirements are:

  • Vim 7.4 (>1087 patch) with +clientserver and python enabled
  • Node v4.4.2 or higher
  • NPM v1.4.2 or higher

Optional dependencies that improve the plugin:

  • UltiSnips

Windows

If using pathogen, clone this repository into your bundle folder.

Run 'npm run install'

OSX

The plugin has not yet been tested on OS X.

Guide

Commands

:SourceJS

  • Executes the JavaScript in the current file against the running VIM instance.

Architecture

Diagram Vim -> Send Events to Python -> TCP client talking to TCP server

TCP Server -> Send response to TCP client -> Execute asynchronously using the 'remote-execute' functionality

API

TODO

Examples

FAQ

Nothing here yet :)

Contact

bryphe@outlook.com

License

This is licensed under the MIT License.

Copyright 2016

About

Write VIM plugins in JavaScript, powered by Electron

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages