vim-jape

Ⅰ. 插件描述

Jape tool support for vim

Ⅱ. 基本信息

创建日期：  2014-09-03
使用用户：  1
Github星：  6
插件作者：  Nikola Petrov

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加: 
Plugin 'nikolavp/vim-jape'
… 然后在Vim中运行以下命令: 
:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加: 
NeoBundle 'nikolavp/vim-jape'
… 然后在Vim中运行以下命令: 
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加: 
Plug 'nikolavp/vim-jape'
… 然后在Vim中运行以下命令: 
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令: 
cd ~/.vim/bundle
git clone https://github.com/nikolavp/vim-jape

Ⅳ. 文档说明

vim-jape

Jape tool support for vim. This includes the following for now:

  • Syntax highlighting
  • Indentation
  • Snippets through Ultisnips
  • Tagbar support
  • Jump to definitions of annotations with ctags

Syntax highlighting

Macros, rules, java code - everything should be highlighted properly. Look at this gorgeous screenshot

Syntax highlighting

Indentation

You should be able to rely on the auto formatting provided by vim-jape. You can even format all your current files with the following:

find -name '*.jape' -exec vim {} -c 'normal gg=GZZ' \;

isn't this awesome(of course check the diff before making the changes blindly)

Snippets

If you are using the excellent Ultisnips you will get the following snippets:

  • imports - creates an import block with a default static import for gate.Utils.*
  • gram - creates a grammar file heading
  • rule - creates a rule without a java on the right hand side
  • jrule - creates a rule with java on the right hand side
  • lhsmacro - creates a macro
  • bra - creates a matching annotation expression
  • look - creates a matching lookup expression with filters
  • tok - creates a token matching expression with filters

Ctags for jumping to definitions

This is not part of vim per se but it is used in the tagbar support. There is an example ctags file that adds support for rules and macros through patters.
You can append it(copy it) in ~/.ctags. Then run

ctags -R *

on your top level directory with jape grammars. This will produce a tags file that contains the different recognized definitions in your file. Then you should point vim to your tags file with

:set tags+=<path-to-tags-file>

you can then jump to definition of a resource by placing the cursor on top of it and pressing ^](ctrl + ]). Press ^t(ctrl + t) to go back.

Sometimes there are many definitions for a single annotation, in those cases ^] will jump to the first match. If you want to jump to a specific definition use :ts <resource-name> to get a list and choose the exact tag by it's number. For example

:ts Location

will show you every place that the Location annotation is defined and will ask you where to jump

Tagbar support

If you are using tagbar and have included the tags file, you will see the tree properly. Look at this gorgeous screenshot
Tagbar screenshot

Installation

For now there is no package but the following methods work as expected

Vimballs

Download the vmb from our release page and run the following

vim -S vim-jape-1.0.vmb

Pathogen

If you are using pathogen

cd ~/.vim/bundle
git clone git://github.com/nikolavp/vim-jape.git

Neobundle

If you are using Neobundle then add the following to your vimrc file

NeoBundle 'nikolavp/vim-jape', {
            \ 'autoload' : {
            \   'filetypes': ['jape'],
            \ },
            \}

you will have to restart so neobundle asks to you install the plugin

Vundle

If you are using Vundle then add the following to your vimrc file

Plugin 'nikolavp/vim-jape'

Development

Some things to note in the repository:

Creating a release

You can run the following:


git tag -a <new-version> -m 'A comment describing the tag'
git push --tags
export V=<new-version>
make vimball VERSION=$V
export GITHUB_TOKEN=<your-token>
github-release release --user nikolavp --repo vim-jape --tag v1.0 --name 'First release' --description 'General availability release for the vim-jape plugin' --file "vim-jape-${V}.vmb"

添加新评论