EditorConfig Vim Plugin
To install this plugin, you can use one of the following ways:
Install with the archive
Download the archive and extract it into your Vim runtime directory
~/.vim on UNIX/Linux and
$VIM_INSTALLATION_FOLDER\vimfiles on windows).
You should have 3 sub-directories in this runtime directory now: "autoload",
"doc" and "plugin".
Install as Vim8 plugin
Install as a Vim 8 plugin. Note
local can be any name, but some path
element must be present. On Windows, instead of
mkdir -p ~/.vim/pack/local/start cd ~/.vim/pack/local/start git clone https://github.com/editorconfig/editorconfig-vim.git
Use pathogen (the git repository of this plugin is https://github.com/editorconfig/editorconfig-vim.git)
Use Vundle by adding to your
.vimrc Vundle plugins section:
Then remember to call
Use vim-plug by adding to your
.vimrc in your plugin section:
Then remember to call
No external editorconfig core library is required
Previous versions of this plugin also required a Python "core".
The core included the code to parse
This plugin includes the core, so you don't need to download the
The EditorConfig Vim plugin supports the following EditorConfig properties:
insert_final_newline(Feature +fixendofline (available on Vim 7.4.785+) or PreserveNoEOL is required for this property)
root(only used by EditorConfig core)
All of the options which are supported are documented in editorconfig.txt
and can be viewed by executing the following:
:help editorconfig. You may
need to execute
:helptags ALL so that Vim is aware of editorconfig.txt.
To ensure that this plugin works well with Tim Pope's fugitive, use the following patterns array:
let g:EditorConfig_exclude_patterns = ['fugitive://.*']
If you wanted to avoid loading EditorConfig for any remote files over ssh:
let g:EditorConfig_exclude_patterns = ['scp://.*']
Of course these two items could be combined into the following:
let g:EditorConfig_exclude_patterns = ['fugitive://.*', 'scp://.*']
You might want to override some project-specific EditorConfig rules in global or local vimrc in some cases, e.g., to resolve conflicts of trailing whitespace trimming and buffer autosaving.
let g:EditorConfig_disable_rules = ['trim_trailing_whitespace']
You are able to disable any supported EditorConfig properties.