Skip to content

Commit

Permalink
executioner.vim 1.2.0
Browse files Browse the repository at this point in the history 
Defaults can be individually overridden instead of forcing the user
to define the whole dictionary.
Defaults can be disabled from loading with g:executioner#load_defaults
  • Loading branch information
@EvanQuan
EvanQuan committed Dec 2, 2018
1 parent 0fa97d4 commit 74beb35
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 57 deletions.
72 changes: 45 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,20 @@ git clone https://github.com/EvanQuan/vim-executioner.git ~/.vim/pack/plugin/sta

#### [Vim-Plug](https://github.com/junegunn/vim-plug)

1. Add `Plug 'EvanQuan/vim-executioner'` to your vimrc file.
2. Reload your vimrc or restart.
1. Add `Plug 'EvanQuan/vim-executioner'` to your `vimrc` file.
2. Reload your `vimrc` or restart.
3. Run `:PlugInstall`

#### [Vundle](https://github.com/VundleVim/Vundle.vim)

1. Add `Plugin 'EvanQuan/vim-executioner'` to your vimrc file.
2. Reload your vimrc or restart.
1. Add `Plugin 'EvanQuan/vim-executioner'` to your `vimrc` file.
2. Reload your `vimrc` or restart.
3. Run `:BundleInstall`

#### [NeoBundle](https://github.com/Shougo/neobundle.vim)

1. Add `NeoBundle 'EvanQuan/vim-executioner'` to your vimrc file.
2. Reload your vimrc or restart.
1. Add `NeoBundle 'EvanQuan/vim-executioner'` to your `vimrc` file.
2. Reload your `vimrc` or restart.
3. Run `:NeoUpdate`

#### [Pathogen](https://github.com/tpope/vim-pathogen)
Expand Down Expand Up @@ -92,7 +92,7 @@ reason, it will not work for programs that require user input.
#### Key mappings

By default, Executioner does not provide any key mappings as to not override
mappings defined in your `.vimrc`. You can map these commands to however you
mappings defined in your `vimrc`. You can map these commands to however you
like to make them easier to use.

For example, I personally use:
Expand Down Expand Up @@ -128,7 +128,7 @@ what file I'm currently editing.
You may want to refer to the full file name or base name in in your commands.
The full file name, which is the base name with file extension, can be referred
to by `g:executioner#full_name`, while the base name can be referred to by
`g:executioner#base_name`, both which you can set in your `.vimrc`. By default
`g:executioner#base_name`, both which you can set in your `vimrc`. By default
they are defined as:

```vim
Expand All @@ -145,10 +145,36 @@ and then execute it.

There are 2 dictionaries that define what types of files can be executed:

With `g:executioner#extensions`, Executioner can execute a command based on the
extension of a file name. With `g:executioner#names`, Executioner can execute
a command based on a file name. If not defined in your `.vimrc`, they are by
default defined as:
`g:executioner#extensions` determines commands by file extension. For example,
if you want to execute files with the `.foo` extension, such as
`hello_world.foo`, with the `bar` command, (i.e. executing `bar
hello_world.foo` in the terminal), then include:
```vim
let g:executioner#extensions['foo'] = 'bar %'
```
in your `vimrc`.

`g:executioner#names` determines commands by file name. For example, if you want
to execute files with the name `echo_me.txt` with the command `echo
echo_me.txt`, then include:
```vim
let g:executioner#names['echo_me.txt'] = 'echo echo_me.txt'
```
in your `vimrc`.

Executioner will prioritize names over extensions when determining what command
to use. For example, if
```vim
let g:executioner#extension['py'] = 'python3 %'
```
dictates that `.py` files are to be executed with `python3` and
```vim
let g:executioner#names['foo.py'] = 'python2 foo.py'
```
dictates that `foo.py` is to be executed with `python2`, then `foo.py` will be
executed with `python2`.

These are the default commands:

```vim
" extension : command
Expand Down Expand Up @@ -180,19 +206,11 @@ let g:executioner#names = {
\}
```

`g:executioner#extensions` determines commands by file extension. For example,
if you want to execute files with the `.foo` extension, such as
`hello_world.foo`, with the `bar` command, (i.e. executing `bar
hello_world.foo` in the terminal), then the value `'foo' : 'bar %'` must be
included in this dictionary.

`g:executioner#names` determines commands by file name. For example, if you want
to execute files with the name `delete_me.txt` with the command `rm
delete_me.txt`, then the value `'delete_me.txt' : 'rm delete_me.txt'` must be
included in this dictionary.
As expected, if any of these extensions or file names are defined in your
`vimrc`, they will take precedence over the defaults.

Executioner will prioritize names over extensions when determining what command
to use. For example: if `g:executioner#extensions` dictates that `py` files are
to be executed with `python3` and `g:executioner#names` dictates that `foo.py`
is to be executed with `python2`, then `foo.py` will be executed with
`python2`.
If you wish to disable these defaults entirely, include:
```vim
let g:executioner#load_defaults = 0
```
in your `vimrc` and they will not be defined.
100 changes: 70 additions & 30 deletions plugin/executioner.vim
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
" ============================================================================
" File: executioner.vim
" Maintainer: https://github.com/EvanQuan/vim-executioner/
" Version: 1.1.2
" Version: 1.2.0
"
" A Vim plugin to easily execute files in the terminal or a separate buffer.
" ============================================================================
Expand All @@ -20,6 +20,10 @@ if !exists("g:executioner#base_name")
let g:executioner#base_name = '@'
endif

if !exists("g:executioner#load_defaults")
let g:executioner#load_defaults = 1
endif

" Fake enums

" Parsed input
Expand All @@ -37,36 +41,72 @@ let s:HORIZONTAL = 3
let s:EXTENSION_COMMAND = 0
let s:NAME_COMMAND = 1

" extension : command
" Command is executed if file has specified extension
if !exists("g:executioner#extensions")
let g:executioner#extensions = {
\ 'c' : 'gcc % -o @.out;./@.out',
\ 'cpp' : 'g++ % -o @.out;./@.out',
\ 'hs' : 'ghci %',
\ 'js' : 'node %',
\ 'm' : 'matlab',
\ 'ml' : 'ocaml % -o @.out;./@.out',
\ 'php' : 'php %',
\ 'pl' : 'perl %',
\ 'prolog' : 'swipl %',
\ 'py' : 'python %',
\ 'py2' : 'python2 %',
\ 'R' : 'Rscript %',
\ 'r' : 'Rscript %',
\ 'rb' : 'ruby %',
\ 'rc' : 'rustc % -o @.out;./@.out',
\ 'sh' : 'bash %',
\ 'swift' : 'swiftc % -o @.out;./@.out',
\}
endif
if g:executioner#load_defaults
" extension : command
" Command is executed if file has specified extension
if !exists("g:executioner#extensions")
let g:executioner#extensions = {}
endif
if !has_key(g:executioner#extensions, 'c')
let g:executioner#extensions['c'] = 'gcc % -o @.out;./@.out'
endif
if !has_key(g:executioner#extensions, 'cpp')
let g:executioner#extensions['cpp'] = 'g++ % -o @.out;./@.out'
endif
if !has_key(g:executioner#extensions, 'hs')
let g:executioner#extensions['hs'] = 'ghci %'
endif
if !has_key(g:executioner#extensions, 'js')
let g:executioner#extensions['js'] = 'node %'
endif
if !has_key(g:executioner#extensions, 'm')
let g:executioner#extensions['m'] = 'matlab'
endif
if !has_key(g:executioner#extensions, 'ml')
let g:executioner#extensions['ml'] = 'ocaml % -o @.out;./@.out'
endif
if !has_key(g:executioner#extensions, 'php')
let g:executioner#extensions['php'] = 'php %'
endif
if !has_key(g:executioner#extensions, 'pl')
let g:executioner#extensions['pl'] = 'perl %'
endif
if !has_key(g:executioner#extensions, 'prolog')
let g:executioner#extensions['prolog'] = 'swipl %'
endif
if !has_key(g:executioner#extensions, 'py')
let g:executioner#extensions['py'] = 'python3 %'
endif
if !has_key(g:executioner#extensions, 'py2')
let g:executioner#extensions['py2'] = 'python2 %'
endif
if !has_key(g:executioner#extensions, 'R')
let g:executioner#extensions['R'] = 'Rscript %'
endif
if !has_key(g:executioner#extensions, 'r')
let g:executioner#extensions['r'] = 'Rscript %'
endif
if !has_key(g:executioner#extensions, 'rb')
let g:executioner#extensions['rb'] = 'ruby %'
endif
if !has_key(g:executioner#extensions, 'rc')
let g:executioner#extensions['rc'] = 'rustc % -o @.out;./@.out'
endif
if !has_key(g:executioner#extensions, 'sh')
let g:executioner#extensions['sh'] = 'bash %'
endif
if !has_key(g:executioner#extensions, 'swift')
let g:executioner#extensions['swift'] = 'swiftc % -o @.out;./@.out'
endif

" file name : command
" Command is executed if file has specified name
if !exists("g:executioner#names")
let g:executioner#names = {
\ 'makefile': 'make',
\}
" file name : command
" Command is executed if file has specified name
if !exists("g:executioner#names")
let g:executioner#names = {}
endif
if !has_key(g:executioner#names, 'makefile')
let g:executioner#names['makefile'] = 'make'
endif
endif

function! s:SplitNameAndExtenstion(file) abort
Expand Down

0 comments on commit 74beb35

Please sign in to comment.