https://github.com/neovim/node-host

node.js host (for Nvim 0.2.0 or older)
https://github.com/neovim/node-host

Last synced: about 1 month ago
JSON representation

node.js host (for Nvim 0.2.0 or older)

• Host: GitHub
• URL: https://github.com/neovim/node-host
• Owner: neovim
• License: mit
• Archived: true
• Created: 2015-07-05T00:27:58.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-11-11T18:34:55.000Z (almost 7 years ago)
• Last Synced: 2024-04-14T00:59:43.211Z (7 months ago)
• Language: Vim script
• Homepage:
• Size: 40 KB
• Stars: 40
• Watchers: 10
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Update

This is no longer needed as it has been merged into neovim! https://github.com/neovim/neovim/pull/7458 🎉

Please direct node client related issues to [neovim client repository](https://github.com/neovim/node-client).

# node-host

## Installation

**Prerequisites:** You must have the `node` executable (currently only 6.x is supported) on your PATH and a copy of `npm`

1. ~~Install this plugin using `vim-plug` or your favorite plugin manager~~

2. Install `neovim` package globally: `npm install -g neovim`

### ~~Example config (vim-plug)~~

```vim

call plug#begin()

  Plug 'neovim/node-host', { 'do': 'npm install -g neovim' }

call plug#end()

```

## Usage

To use a Node plugin, place the appropriate file or folder in `rplugin/node` in a `runtimepath` directory (e.g. `~/.nvim/rplugin/node`), run `npm install` if necessary, and then execute a `:UpdateRemotePlugins`.

You *must* restart neovim after a `:UpdateRemotePlugins` before you can use your new plugin.

## Writing plugins

A plugin can either be a file or folder in the `rplugin/node` directory. If the plugin is a folder, the `main` script from `package.json` will be loaded.

Please see the [neovim client repository](https://github.com/neovim/node-client) for documentation on how to write a plugin (API is currently a WIP)