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
Type: object

A schema for config of dein.vim (https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L963)

Properties

plugins Plugin[] required

Definition properties table for installing a vim plugin. It is converted to |dein#add()|.

ftplugin object

'' key is executed after all ftplugin. '{filetype}' key is executed {filetype} ftplugin. You can define multiple filetypes by '{filetype1}{filetype2}' key.

1 nested properties
_ string

'_' key is executed after all ftplugin.

hook_add string

It is the global |dein-options-hook_add|. It is executed in |dein#end()|.

multiple_plugins MultiplePlugins[]

It is converted to |dein-toml-hook_add| "plugins" key is needed.

Definitions

Plugin object
repo Url | Path | repo-string-pattern required

The repository URI or local repository directory path.

augroup string

An augroup name that the plugin uses for |VimEnter| or |GUIEnter| autocmd events.

build string

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.

depends string[] | string
frozen boolean | number
ftplugin object

'_' key is executed after all ftplugin. '{filetype}' key is executed {filetype} ftplugin.

1 nested properties
_ string

'_' key is executed after all ftplugin.

if boolean | integer | string

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

lazy boolean | integer

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()|.

merged boolean | number
merge_ftdetect boolean | number
name string

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.

normalized_name string

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.

on_cmd string[] | string
on_event string[] | string
on_func string[] | string
on_ft string[] | string
on_if string

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|.

on_lua string[] | string

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.

on_path string[] | string
on_source string[] | string
overwrite boolean | number
path string

Specify the plugin downloaded path.

rev string

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.

rtp string

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'

Default: "vim"
script_type string

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.

Values: "indent" "plugin" "colors" "ftplugin"
timeout integer

The time of timeout seconds when updating/installing plugins. If omit it, |g:dein#install_process_timeout| will be used.

trusted boolean | number
type string

Specify the repository type. If it is omitted, a guess is made based on {repository}.

Values: "none" "raw" "git"
type__depth integer

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

hook_add string

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'.

hook_done_update string

It is executed after the all plugins are updated.

hook_post_source string

It is executed after plugins are sourced. Note: In Vim initializing, you must call the 'hook_post_source' hooks manually in |VimEnter| if needed.

hook_post_update string

It is executed after the plugins are updated.

hook_source string

It is executed before plugins are sourced. Note: The 'sourced' means after |dein#end()| or when |VimEnter| or autoloaded. 'type': 'string',

lua_add string

Lua language string hook instead of Vim script. It is converted to "hook_add" key.

lua_source string

Lua language string hook instead of Vim script. It is converted to "hook_source" key.

MultiplePlugins object
plugins repo-string-pattern[] required

The repository URI or local repository directory path.

Url string
repo-string-pattern string

If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.

Path string
vim-mode-key-pattern-string string
vim-mode-key-mapping-string string
on_map-string string
on_map-array1 on_map-string[]
on_map-array2 vim-mode-key-mapping-string[]
on_map-array on_map-array1 | on_map-array2
on_map-dict object
ArrayOrString string[] | string
Boolean boolean | number