Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haya14busa/vital-power-assert
:muscle: Power Assert in Vim script
https://github.com/haya14busa/vital-power-assert
Last synced: 29 days ago
JSON representation
:muscle: Power Assert in Vim script
- Host: GitHub
- URL: https://github.com/haya14busa/vital-power-assert
- Owner: haya14busa
- License: mit
- Created: 2015-08-19T15:15:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-07T15:43:55.000Z (almost 5 years ago)
- Last Synced: 2024-05-02T01:26:07.487Z (7 months ago)
- Language: Vim script
- Homepage:
- Size: 103 KB
- Stars: 32
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
:muscle: vital-power-assert :muscle:
====================================
[](https://travis-ci.org/haya14busa/vital-power-assert)
[](https://ci.appveyor.com/project/haya14busa/vital-power-assert)
[](https://github.com/haya14busa/vital-power-assert/releases)
[](https://github.com/haya14busa/vital-power-assert/issues)
[](LICENSE)
[](doc/vital-power-assert.txt)
[haya14busa/vital-power-assert](https://github.com/haya14busa/vital-power-assert)
provides descriptive assertion messages with assertion function or :command.
```vim
let s:V = vital#vital#new()
let s:PowerAssert = s:V.import('Vim.PowerAssert')
let s:assert = s:PowerAssert.assert
execute s:PowerAssert.define('PowerAssert')
function! s:power_assert() abort
let x = { 'ary': [1, 2, 3], 'power': 'assert' }
let l:zero = 0
let s:two = 2
PowerAssert index(x.ary, l:zero) is# s:two
" or
execute s:assert('index(x.ary, l:zero) is# s:two')
endfunction
call s:power_assert()
```
=>
```txt
vital: PowerAssert:
index(x.ary, l:zero) is# s:two
||| | | |
||| | | 2
||| | 0
||| 0
||[1, 2, 3]
|{'ary': [1, 2, 3], 'power': 'assert'}
-1
```
Installation
------------
### 1. Install |vital.vim|, vital-vimlcompiler, and |vital-power-assert| with your favorite plugin manager.
```vim
NeoBundle 'vim-jp/vital.vim'
NeoBundle 'haya14busa/vital-vimlcompiler'
NeoBundle 'haya14busa/vital-power-assert'
NeoBundle 'haya14busa/vital-safe-string'
Plugin 'vim-jp/vital.vim'
Plugin 'haya14busa/vital-vimlcompiler'
Plugin 'haya14busa/vital-power-assert'
Plugin 'haya14busa/vital-safe-string'
Plug 'vim-jp/vital.vim'
Plug 'haya14busa/vital-vimlcompiler'
Plug 'haya14busa/vital-power-assert'
Plug 'haya14busa/vital-safe-string'
```
### 2. Embed vital-power-assert into your plugin with |:Vitalize| (assume current directory is the root of your plugin repository).
See |:Vitalize| for more information.
```vim
:Vitalize . --name={plugin_name} Vim.PowerAssert
```
### 3. You can update vital-power-assert with |:Vitalize|.
```vim
:Vitalize .
```
### 4. Please add following lines in your vimrc.
```vim
let g:__vital_power_assert_config = {
\ '__debug__': 1
\ }
```
Usage
-----
You can assert expression with `function` or `command`.
Both method support assertion with any scope variable or function like s:var and
they does nothing unless `g:__vital_power_assert_config.__debug__` is true.
### Function (`.assert()`)
```vim
let s:V = vital#vital#new()
let s:PowerAssert = s:V.import('Vim.PowerAssert')
let s:assert = s:PowerAssert.assert
let x = 1
execute s:assert('x == 2')
" =>
" vital: PowerAssert:
" x == 2
" | |
" | 0
" 1
```
It execute assertion from given string expression.
If it's true, vital-power-assert does nothing.
If it's false, it throws exception with descriptive graphical message.
If `g:__vital_power_assert_config.__debug__` is false (default),
this function does nothing even if assertion will fail, so you can leave
assertion lines in production code if you want.
### Command (`.define()`)
```vim
let s:V = vital#vital#new()
let s:PowerAssert = s:V.import('Vim.PowerAssert')
execute s:PowerAssert.define('PowerAssert')
let x = 1
PowerAssert x == 2
" =>
" vital: PowerAssert:
" x == 2
" | |
" | 0
" 1
```
You can define assertion command with `.define()` and you that command like `.assert()`.
It's better than `.assert()` because you don't have to wrap expression with string, but
since it define new command, it annoys your plugin users.
I strongly recommend not to leave assertion command in your plugin.
NOTE: To handle script-local variables, you have to define command in each file (with different name not to overwrite previous one).
I recommend to use the assert command in https://github.com/thinca/vim-themis
### Use vital-power-assert in themis
#### .themisrc
```vim
call themis#option('runtimepath', expand('~/.vim/bundle/vital.vim'))
call themis#option('runtimepath', expand('~/.vim/bundle/vital-vimlcompiler'))
let g:__vital_power_assert_config = {
\ '__debug__': 1,
\ '__pseudo_throw__': 0
\ }
```
### test/Example.vimspec
```vim
Describe Example
Before all
let V = vital#vital#new()
let PowerAssert = V.import('Vim.PowerAssert')
execute PowerAssert.define('PowerAssert')
" or
let s:assert = PowerAssert.assert
End
It throw exception with descriptive graphical message
let x = { 'ary': [1, 2, 3], 'power': 'assert' }
let l:zero = 0
let s:two = 2
PowerAssert index(x.ary, l:zero) is# s:two
" or
execute s:assert('index(x.ary, l:zero) is# s:two')
End
End
```
### Output
```
# themis --reporter spec test/Example.vimspec
Example
[✖] throw exception with descriptive graphical message
function 114() abort dict Line:5 (/tmp/va1bids/0)
vital: PowerAssert:
index(x.ary, l:zero) is# s:two
||| | | |
||| | | 2
||| | 0
||| 0
||[1, 2, 3]
|{'ary': [1, 2, 3], 'power': 'assert'}
-1
tests 1
passes 0
fails 1
```
Credit
------
### https://github.com/power-assert-js/power-assert
vital-power-assert is inspired by power-assert-js.
### https://github.com/ynkdir/vim-vimlparser
Vim script parser written in Vim script which vital-power-assert and vital-vimlcompiler use.
:bird: Author
-------------
haya14busa (https://github.com/haya14busa)