{"id":16667468,"url":"https://github.com/bryphe/vim-electrify","last_synced_at":"2025-07-16T01:04:43.700Z","repository":{"id":42419713,"uuid":"50799001","full_name":"bryphe/vim-electrify","owner":"bryphe","description":"Write VIM plugins in JavaScript, powered by Electron","archived":false,"fork":false,"pushed_at":"2017-12-07T03:20:39.000Z","size":605,"stargazers_count":18,"open_issues_count":13,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-13T07:01:22.216Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bryphe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-31T22:31:22.000Z","updated_at":"2024-04-04T20:59:58.000Z","dependencies_parsed_at":"2022-09-01T04:41:33.421Z","dependency_job_id":null,"html_url":"https://github.com/bryphe/vim-electrify","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bryphe/vim-electrify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryphe%2Fvim-electrify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryphe%2Fvim-electrify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryphe%2Fvim-electrify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryphe%2Fvim-electrify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryphe","download_url":"https://codeload.github.com/bryphe/vim-electrify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryphe%2Fvim-electrify/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265472515,"owners_count":23771893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T11:14:16.345Z","updated_at":"2025-07-16T01:04:43.657Z","avatar_url":"https://github.com/bryphe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/extr0py/vim-electrify.svg?branch=master)](https://travis-ci.org/extr0py/vim-electrify)\n[![Stories in Ready](https://badge.waffle.io/extr0py/vim-electrify.png?label=ready\u0026title=Ready)](https://waffle.io/extr0py/vim-electrify)\n# vim-electrify\n###### Write VIM plugins in JavaScript, powered by [Electron](http://electron.atom.io)\n---------------------------------------------------\n\n- [Intro](#intro)\n-   [Plugins](#plugins)\n- [Installation](#installation)\n    - [Prerequisites](#prerequisites)\n    - [Windows](#windows)\n    - [OSX](#osx)\n- [Guide](#guide)\n    - [Architecture](#architecture)\n    - [API](#api)\n    - [Examples](#examples)\n- [FAQ](#faq)\n- [Contact](#contact)\n- [License](#license)\n\nIntro\n-----\nvim-electrify is a VIM plugin that enables the authoring of JavaScript plugins,\nrunning in a Node/Electron environment. \n\n![vim-electrify-demo](http://i.imgur.com/WmLBYHj.gif)\n\nThat shows some basic functionality in the API - both receiving messages and sending messages to VIM.\nThe real power of this, though, is writing plugins in JavaScript - and leveraging all the rich\ndebugging tools that are available in that ecosystem.\n\n### Plugins\n##### Plugins built with vim-electrify\n- [vim-electrify-typescript-completion](https://github.com/extr0py/vim-electrify-typescript-completion) \n    - Provides autocompletion for TypeScript and JavaScript\n- [vim-electrify-markdown-preview](https://github.com/extr0py/vim-electrify-markdown-preview)\n    - A markdown preview engine, uses Electron's BrowserWindow\n\nInstallation\n------------\n\nCurrently, this plugin is only tested on Windows 10, with Vim. It should be \nrelatively straightforward to make it work on OS X, however there will likely\nbe some fixes required.\n\n### Prerequisites\n\nOther requirements are:\n- Vim 7.4 (\u003e1087 patch) with +clientserver and python enabled\n- Node v4.4.2 or higher\n- NPM v1.4.2 or higher\n\nOptional dependencies that improve the plugin:\n- UltiSnips\n\n### Windows\n\n    If using pathogen, clone this repository into your bundle folder.\n\n    Run 'npm run install'\n\n### OSX\n\nThe plugin has not yet been tested on OS X.\n\nGuide\n=====\n\n### Commands\n\n`:SourceJS`\n\n- Executes the JavaScript in the current file against the running VIM instance.\n\n### Architecture\n\nDiagram\nVim -\u003e Send Events to Python -\u003e TCP client talking to TCP server\n\nTCP Server -\u003e Send response to TCP client -\u003e Execute asynchronously using the 'remote-execute' functionality\n\n### API\n\nTODO\n\n### Examples\n\n- [Echo](samples/echo.js)\n- [Eval](samples/eval.js)\n- [Command](samples/command.js)\n- [Omnicompleter](samples/omnicompleter_simple.js);\n- [BrowserWindow](samples/browserwindow.js)\n- [Setting qflist/loclist](samples/lists.js)\n- [Showing errors](samples/errors.js)\n- [Open a buffer](samples/open.js)\n\nFAQ\n===\n\nNothing here yet :)\n\nContact\n=======\n\nbryphe@outlook.com\n\nLicense\n=======\n\nThis is licensed under the MIT License.\n\nCopyright 2016 \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryphe%2Fvim-electrify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryphe%2Fvim-electrify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryphe%2Fvim-electrify/lists"}