https://github.com/samtebbs33/vim-exec
Execute current file open in vim
https://github.com/samtebbs33/vim-exec
vim vim-plugin vim-script
Last synced: 2 months ago
JSON representation
Execute current file open in vim
- Host: GitHub
- URL: https://github.com/samtebbs33/vim-exec
- Owner: SamTebbs33
- License: gpl-2.0
- Created: 2015-11-18T13:43:10.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-12T00:26:09.000Z (over 9 years ago)
- Last Synced: 2025-03-14T20:47:40.679Z (10 months ago)
- Topics: vim, vim-plugin, vim-script
- Language: VimL
- Homepage:
- Size: 22.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vim-exec
A vim plugin that executes the current file.
# Contents
* Installation
* Usage
* Key mapping
* Adding commands
* Clearing the terminal
* Vimux/tmux support
* Default filetypes
Installation
=====================================
Install [pathogen](https://github.com/tpope/vim-pathogen), and then clone this repo into your `.vim/bundle` directory.
```
cd ~/.vim/bundle && git clone https://github.com/SamTebbs33/vim-exec
```
Usage
=======================
Key mapping
---------------------------
The default key mapping is to `F12`, which can be changed by reassigning `g:vim_exec_key` in your `.vimrc` and then calling `VimExecMap()`.
```
" Map to e
let g:vim_exec_key = "e"
call VimExecMap()
```
Adding commands
------------------------------------
Some common commands are provided by default (run `:call VimExecCmds()` to see a list of those), but more can be added easily.
The variable that stores the commands is called `g:vim_exec_cmds` and is a dictionary, where the key is the filetype and the value is the command to execute.
To create a new command or override an existing one:
```
let g:vim_exec_cmds["filetype"] = "cmd"
```
Where "filetype" is the filetype you want the command to apply to and "cmd" is the command itself. Use `%` to represent the path to the current file. Note that `:` is added to the beginning and `` is not needed at the end. Open a file of the filetype and press the key that is bound to VimExec to test the new command.
If you'd like to add a command that will be supplied by default, fork the repo, edit the `plugin/vim-exec.vim` file and add the filetype and command to the end of the `g:vim_exec_cmds` dictionary.
```
let g:vim_exec_cmds = {..., "new-filetype" : "new-comand"}
```
Then open a pull request. I will merge the pull request if the change is relevant and doesn't do anything malicious to the user's system (i.e, no `rm -rf /*`)
Clearing the terminal
------------------------------------------
By default, VimExec will not clear the terminal screen (not the vim buffer window) before executing a command. To enable this:
```
let g:vim_exec_clear = 1
```
To change the command used to clear the screen (It is `clear` by default):
```
let g:vim_exec_clearcmd = "cls"
```
Vimux/tmux support
------------------------------------
vim-exec can output to a tmux pane rather than the default terminal if [vimux](https://github.com/benmills/vimux) is installed. To enable this:
```
let g:vim_exec_vimux = 1
```
You must be runnign an instance of tmux in order for this to work.
Default filetypes
======================================
Below is a list of the filetypes that are supported by default and their requirements (if there are any).
* **Python**
* **OCaml**
* **VimScript**
* **JavaScript**: Node.js
* **HTML**
* **Bash script**
* **Haskell**: Ghci
See the "Adding execution commands" section for info on adding more filetypes. More will be added to the default set when they are thought of.