ex-mode/README.md
2017-01-08 17:05:30 -08:00

41 lines
972 B
Markdown

# ex-mode package
ex-mode for Atom's vim-mode
## Use
Install both [vim-mode-plus](https://github.com/t9md/atom-vim-mode-plus) (or
the deprecated `vim-mode`) and ex-mode. Type `:` in command mode. Enter `w` or
`write`.
## Extend
Use the service to register commands, from your own package, or straight from `init.coffee`:
```coffee
# in Atom's init.coffee
atom.packages.onDidActivatePackage (pack) ->
if pack.name == 'ex-mode'
Ex = pack.mainModule.provideEx()
Ex.registerCommand 'z', -> console.log("Zzzzzz...")
```
You can also add aliases:
```coffee
atom.packages.onDidActivatePackage (pack) ->
if pack.name == 'ex-mode'
Ex = pack.mainModule.provideEx()
Ex.registerAlias 'WQ', 'wq'
Ex.registerAlias 'Wq', 'wq'
```
See `lib/ex.coffee` for some examples commands. Contributions are very welcome!
## Status
Groundwork is done. More ex commands are easy to add and will be coming as time permits and contributions come in.
## License
MIT