https://github.com/bryphe/vim-electrify

Write VIM plugins in JavaScript, powered by Electron
https://github.com/bryphe/vim-electrify

Last synced: 11 months ago
JSON representation

Write VIM plugins in JavaScript, powered by Electron

• Host: GitHub
• URL: https://github.com/bryphe/vim-electrify
• Owner: bryphe
• Created: 2016-01-31T22:31:22.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-12-07T03:20:39.000Z (over 8 years ago)
• Last Synced: 2025-07-13T07:01:22.216Z (11 months ago)
• Language: TypeScript
• Homepage:
• Size: 591 KB
• Stars: 18
• Watchers: 2
• Forks: 2
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/extr0py/vim-electrify.svg?branch=master)](https://travis-ci.org/extr0py/vim-electrify)

[![Stories in Ready](https://badge.waffle.io/extr0py/vim-electrify.png?label=ready&title=Ready)](https://waffle.io/extr0py/vim-electrify)

# vim-electrify

###### Write VIM plugins in JavaScript, powered by [Electron](http://electron.atom.io)

---------------------------------------------------

- [Intro](#intro)

-   [Plugins](#plugins)

- [Installation](#installation)

    - [Prerequisites](#prerequisites)

    - [Windows](#windows)

    - [OSX](#osx)

- [Guide](#guide)

    - [Architecture](#architecture)

    - [API](#api)

    - [Examples](#examples)

- [FAQ](#faq)

- [Contact](#contact)

- [License](#license)

Intro

-----

vim-electrify is a VIM plugin that enables the authoring of JavaScript plugins,

running in a Node/Electron environment. 

![vim-electrify-demo](http://i.imgur.com/WmLBYHj.gif)

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

- [vim-electrify-typescript-completion](https://github.com/extr0py/vim-electrify-typescript-completion) 

    - Provides autocompletion for TypeScript and JavaScript

- [vim-electrify-markdown-preview](https://github.com/extr0py/vim-electrify-markdown-preview)

    - A markdown preview engine, uses Electron's BrowserWindow

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

- [Echo](samples/echo.js)

- [Eval](samples/eval.js)

- [Command](samples/command.js)

- [Omnicompleter](samples/omnicompleter_simple.js);

- [BrowserWindow](samples/browserwindow.js)

- [Setting qflist/loclist](samples/lists.js)

- [Showing errors](samples/errors.js)

- [Open a buffer](samples/open.js)

FAQ

===

Nothing here yet :)

Contact

=======

bryphe@outlook.com

License

=======

This is licensed under the MIT License.

Copyright 2016