Repository files navigation

A comprehensive Vim utility functions for Vim plugins.

Modules in vital.vim basically support Vim 8.2 or later.We guarantee that the following versions of Vim are supported:

• The latest major version (9.0.*)
• The previous major version (8.2.*)

And some modules have stricter requirements and additional dependencies.Please read the docs of each module before using them.

Since Vim script has no built-in module system, using external libraries had been troublesome.

• If you decide to include the libraries in your plugin repository by copy&paste manually:You are responsible for updating the libraries by yourself.sighYou have to find backward-incompatible changes that can break your plugin from every changes between the previous version you installed in the past.super tedious
• If you want the plugin users to install the dependent libraries:The users will receive additional steps to get it working with your plugin.not easyEven worse, they may fail to install the dependencies properly.a bad dream

vital.vim will embed libraries into your plugin repository and thus your plugin users don't need to install them separately.Additionally,vital.vim can also resolve the dependencies according to the declaration onvital modules.

Concretely,vital.vim resolves the dependencies amongvital modules by the module bundler calledvitalizer.vitalizer can bundle only necessary modules and can update an existing bundle.On updating the modules,vitalizer shows any breaking changes to help you migrate to the new version ofvital modules.

... and you can also create your own vital modules. Please seeExternal vital modules for more information.

Use:Vitalize to install modules.Assuming your Vim plugin name isyour_plugin_name and plugin directory isyour_plugin_dir.Please seethe help for more details.

:Vitalize--name=your_plugin_name$HOME/.vim/bundle/your_plugin_dir/

You can also install only specified modules; recommended for making yourrepository size small, assuming you are going to upload it to a remoterepository

:Vitalize--name=your_plugin_name$HOME/.vim/bundle/your_plugin_dir/ Data.String Data.List

Assuming your Vim plugin name isyour_plugin_name. You can define your utilityfunction setyour_plugin_name#util just by

lets:Process=vital#your_plugin_name#import('System.Process')function!your_plugin_name#util#system(...)returns:Process.execute(a:000)endfunction" run" echo your_plugin_name#util#system('echo','abc')" -> $ echo abc

and then you can call functions byyour_plugin_name#util#system(), without taking careofvital.vim itself. It's all hidden.

Vital has module system. The below is an example to import/load a moduleMath and to call a functionlcm() of the module.

" Recommended waylets:M=vital#your_plugin_name#import('Math')calls:M.lcm([2,3,4])" -> 12

or

" Alternative waylets:V=vital#your_plugin_name#new()lets:M=s:V.import('Math')calls:M.lcm([2,3,4])" -> 12

or

" Alternative way only if you rarely use the modulelets:V=vital#your_plugin_name#new()calls:V.load('Math')calls:V.Math.lcm([2,3,4])" -> 12

or

" Available, but we don't recommend this very muchlets:V=vital#your_plugin_name#new()calls:V.import('Math',s:)calls:lcm([2,3,4])" -> 12

We recommend you to use a capital letter for a Vital module dictionary to assign.

A lot of vim plugins are using vital.vim

• wiki
• google search

It is not necessary but we recommend adding a badge to your project README to make the vital.vim developers happy ;-)The following is a markdown snippet.

[![Powered by vital.vim](https://img.shields.io/badge/powered%20by-vital.vim-80273f.svg)](https://github.com/vim-jp/vital.vim)

The badge usesShields.io so you can customize the looks as like:

• (Default)
• by adding?style=plastic
• by adding?style=flat
• by adding?style=flat-square

Become a vital.vim Developer

• Delegation in Vim script
• Core concept of vital (in Japanese)
• How to make a vital module (in Japanese)
• API Reference (in Japanese)
• Let's use vital.vim (in Japanese)

NYSL

Japanese original text:http://www.kmonos.net/nysl/

NYSL is a very loose license like aBeer License, or more likeWTFPL.SeeNYSL for details. (English and Japanese)

First, vital.vim is a bundling (static) library.We think everyone should be able to use it easily, without worrying aboutlicensing stuff too much.

Second, In Japan,Strict Public Domain might be invalid.You outside Japan may interpret simply the license as Public Domain.

That's why we chose NYSL.

(See#26 about the discussion.)