Repository files navigation

This is anEditorConfig plugin for Vim. This plugin can be found on bothGitHub andVim online.

Depending on which version of Vim or Neovim you are using, you might not need tospecifically install this plugin at all:

• Vim 9.0.1799 and above comes bundled witha recent stable version of thisplugin.
• Neovim 0.9 and above comes withits own Lua-based implementation.

To install this plugin, you can use one of the following ways:

Download thearchive and extract it into your Vim runtime directory(~/.vim on UNIX/Linux and$VIM_INSTALLATION_FOLDER\vimfiles on windows).You should have 4 sub-directories in this runtime directory now: "autoload","doc", "ftdetect" and "plugin".

Install as a Vim 8 plugin. Notelocal can be any name, but some pathelement must be present. On Windows, instead of~/.vim use$VIM_INSTALLATION_FOLDER\vimfiles.

mkdir -p~/.vim/pack/local/startcd~/.vim/pack/local/startgit clone https://github.com/editorconfig/editorconfig-vim.git

Use pathogen (the git repository of this plugin ishttps://github.com/editorconfig/editorconfig-vim.git)

Use Vundle by adding to your.vimrc Vundle plugins section:

Plugin'editorconfig/editorconfig-vim'

Then call:PluginInstall.

Use vim-plug by adding to your.vimrc in your plugin section:

Plug'editorconfig/editorconfig-vim'

Source your.vimrc by calling:source $MYVIMRC.

Then call:PlugInstall.

Previous versions of this plugin also required a Python "core".The core included the code to parse.editorconfig files.This pluginincludes the core, so you don't need to download thecore separately.

Vim v9.1.0543 and Neovim v0.10.x or earlier versions: This plugin after version1.2.1 will not automatically set.editorconfig filetype todosini. Pleaseinstall version 1.2.1 of this plugin if you would like to retain this behavior.

The EditorConfig Vim plugin supports the following EditorConfigproperties:

• indent_style
• indent_size
• tab_width
• end_of_line
• charset
• insert_final_newline (Feature+fixendofline, available on Vim 7.4.785+,orPreserveNoEOL is required for this property)
• trim_trailing_whitespace
• max_line_length
• root (only used by EditorConfig core)

The supported options are documented ineditorconfig.txtand can be viewed by executing the following::help editorconfig. You mayneed to execute:helptags ALL so that Vim is aware of editorconfig.txt.

To ensure that this plugin works well withTim Pope's fugitive, use thefollowing patterns array:

letg:EditorConfig_exclude_patterns= ['fugitive://.*']

If you wanted to avoid loading EditorConfig for any remote files over ssh:

letg:EditorConfig_exclude_patterns= ['scp://.*']

Of course these two items could be combined into the following:

letg:EditorConfig_exclude_patterns= ['fugitive://.*','scp://.*']

You can disable this plugin for a specific buffer by settingb:EditorConfig_disable. Therefore, you can disable theplugin for all buffers of a specific filetype. For example, to disableEditorConfig for all git commit messages (filetypegitcommit):

auFileTypegitcommitletb:EditorConfig_disable=1

In very rare cases,you might need to override some project-specific EditorConfig rules in globalor local vimrc in some cases, e.g., to resolve conflicts of trailing whitespacetrimming and buffer autosaving. This is not recommended, but you can:

letg:EditorConfig_disable_rules= ['trim_trailing_whitespace']

You are able to disable any supported EditorConfig properties.

Feel free to submit bugs, feature requests, and other issues to theissue tracker. Be sure you have read thecontribution guidelines!