Dein Config
Dein.vim, a Vim/Neovim plugin manager
| Type | object |
|---|---|
| File match |
dein.toml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/dein-config/latest.json |
| Source | https://www.schemastore.org/dein.json |
Validate with Lintel
npx @lintel/lintel check
A schema for config of dein.vim (https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L963)
Properties
Definition properties table for installing a vim plugin. It is converted to |dein#add()|.
'' key is executed after all ftplugin. '{filetype}' key is executed {filetype} ftplugin. You can define multiple filetypes by '{filetype1}{filetype2}' key.
1 nested properties
'_' key is executed after all ftplugin.
It is the global |dein-options-hook_add|. It is executed in |dein#end()|.
It is converted to |dein-toml-hook_add| "plugins" key is needed.
Definitions
The repository URI or local repository directory path.
An augroup name that the plugin uses for |VimEnter| or |GUIEnter| autocmd events.
Specify the build script. This command is executed by |system()| in the plugin runtimepath. Note: In previous versions of dein, build could also be of type dictionary, but that is now deprecated. Please use |dein-options-hook_post_update| instead.
'_' key is executed after all ftplugin. '{filetype}' key is executed {filetype} ftplugin.
1 nested properties
'_' key is executed after all ftplugin.
If set to v:false, dein doesn't register the plugin, i.e. the plugin will be disabled. If it is String, dein will eval it. If you don't set it, dein will register (enable) the plugin
If set to v:true, dein doesn't add the path to 'runtimepath' automatically. If you don't set it, dein will set it automatically when the conditions are met. Note: You should not specify the plugins which have no 'plugin/' directory as lazy load plugins. It is meaningless and just increases the overhead. You can get the no meaning lazy plugins by |dein#check_lazy_plugins()|.
Specify the name of the plugin. This is used for dein management and other functions. If it is omitted, the tail of the repository name will be used. Note: Must be unique across the all plugin. If the plugin name conflicts with another plugin, dein will overwrite the previous settings with the new one. If the repo tail is bound to conflict, you can set the 'name' option manually to prevent overwriting an existing plugin setting.
Specify the normalized name of the plugin. If omitted, dein will normalize the tail of the repository name. Note: Must be unique across all plugins.
If it is evaluated and it is non-zero, dein will call|dein#source()|.The default evaluate timings are 'BufRead', 'BufNewFile','VimEnter' and 'FileType'.If |dein-options-on_event| exists, it is evaluated when|dein-options-on_event|.
If it is the Dictionary, the key is {mode} and the items are{mapping} or [{mapping1}, {mapping2}, ...].If it is the List, the items are {mapping} or [{mode},{mapping1}, [{mapping2}, ...]].If {mode} is omitted, 'nx' is used.
Specify the plugin downloaded path.
Specify a revision number or branch/tag name. If it is '' in 'git' type, dein will use latest released tag.You can specify the wildcards like '0.'.Note: If the type is 'raw', rev must be hash number.
Specify the runtime path. You can use it when the repository has the Vim plugin in a subdirectory.For example: https://github.com/rstacruz/sparkup If it is empty string, dein will not add the path to'runtimepath'
Specify the script type. It is useful for non-official categorized plugins. For example: 'indent', 'plugin', 'ftplugin', ... Note: You must not specify it for categorized plugins.
The time of timeout seconds when updating/installing plugins. If omit it, |g:dein#install_process_timeout| will be used.
Specify the repository type. If it is omitted, a guess is made based on {repository}.
The history depth for 'git clone'. If omitted, |g:dein#types#git#clone_depth| is used. If it is than 0, dein clones the repository by shallow clone. Shallow clone feature saves your repository clone time. But it has problems in some repository. Note: This attribute is available in git type only.
https://github.com/Shougo/neobundle.vim/issues/81 https://github.com/Homebrew/homebrew/issues/12024
It is executed after the line is parsed. Note: You cannot call plugin function in 'hook_add'. Because the plugin is not sourced when 'hook_add'.
It is executed after the all plugins are updated.
It is executed after plugins are sourced. Note: In Vim initializing, you must call the 'hook_post_source' hooks manually in |VimEnter| if needed.
It is executed after the plugins are updated.
It is executed before plugins are sourced. Note: The 'sourced' means after |dein#end()| or when |VimEnter| or autoloaded. 'type': 'string',
Lua language string hook instead of Vim script. It is converted to "hook_add" key.
Lua language string hook instead of Vim script. It is converted to "hook_source" key.
The repository URI or local repository directory path.
If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.