Skip to content

Latest commit

 

History

History
91 lines (51 loc) · 2.06 KB

README.md

File metadata and controls

91 lines (51 loc) · 2.06 KB
Raw

Vim.js : JavaScript port of Vim

A Tool/Toy for Non-Beginners

by Lu Wang

Try it online

Status

    | Firefox | Chrome | IE

--------|---------|--------|-------- Speed | Normal | Best | Good Feature | Best | Normal | Good

Usable and almost stable, but be careful and do :w a lot! In case it crashes, files can still be accessible through the emscripten FS API, e.g. FS.readFile

Vim.js Features

  • Persistent ~/.vimrc
  • Execute JavaScript from Vim.js
  • Read local files
  • Read files from Dropbox

Run :e $VIM/vimrc for more detail.

Vim Features

The online demo is built with the small feature set (--with-features=small), with also a few from the normal set. Run :version to check details. (--with-features=normal is too large and too slow for online usage.)

Some features can be requested via pull requests, some are not intended to be included. Please discuss with me first before you work on a PR.

Instructions for hackers

  • Prepare the dependencies:
    • emscripten
    • node.js
    • streamline.js
    • GCC & cproto (maybe) — Sometimes you need to run make proto when you see errors about 'undeclared variables/functions/structs'
  • Get yourself familiar with everything above and also:
    • source code of vim
    • JavaScript, and also HTML/CSS
  • Set up the EM_DIR environment variable
  • Set up JOB_COUNT in build.sh
  • Uncomment the last few lines in build.sh
  • Run build.sh

The building process might take more than 3GB memory.

Development

Patches are welcome and wanted for

  • Wrapping async functions — learn more
  • Multi-browser/platform support
  • Stability improvements
  • UI improvements
  • Other stuffs in TODO

If you want to work on other features to be merged, please file an issue and discuss with me first.

Do not override vim.js or build.sh!

Contact

Lu Wang coolwanglu(a)gmail.com — please do not expect a prompt response.

License

Read LICENSE