EditorConfig Emacs Plugin
If you use use-package, add the following to your
(use-package editorconfig :ensure t :config (editorconfig-mode 1))
To install manually, copy all
.el files in this repository to
~/.emacs.d/lisp and add the following:
(add-to-list 'load-path "~/.emacs.d/lisp") (require 'editorconfig) (editorconfig-mode 1)
Install a Core Program
This package requires a Core program. The officially recommended one is EditorConfig C Core, follow the instructions in the README and INSTALL files to install it.
Though using C Core is recommended, but this plugin also includes a core library implemented in Emacs Lisp. This plugin uses this as a fallback method when no core executable is found, so it works out-of-the-box without explicitly installing any other core program.
Current Emacs plugin coverage for EditorConfig's properties:
insert_final_newline = trueis supported
is not enforced (as in trailing newlines actually being removed automagically), we just buffer-locally override any preferences that would auto-add them to files
insert_final_newline = false
.editorconfigmarks as trailing-newline-free
root(only used by EditorConfig core)
Not yet covered properties marked with
– pull requests implementing missing features warmly welcomed!
Typically, you will want to tie these to native functionality,
or the configuration of existing packages handling the feature.
As several packages have their own handling of, say, indention, we might not yet cover some mode you use, but we try to add the ones that show up on our radar. Similarly, we don't yet hook in to all different packages for whitespace trimming to inform them about editorconfig settings, but aim for better coverage of things like ws-trim.
This plugin has experimental supports for
file_type_emacs, which specify "file types" for files.
As for Emacs, it means
major-mode can be set.
file_type_ext When it is set to
a.txt, for example,
major-mode will be decided as if the file name would be
markdown-mode is likely to be used).
file_type_emacs When it is set to
markdown-mode will be enabled when opening
These property are experimental and their meanings might change in the
future updates. When both are specified,
file_type_ext takes precedence.
editorconfig-emacs provides some customize variables.
Here are some of these variables: for the full list of available variables, type M-x customize-group [RET] editorconfig [RET].
A list of functions after loading common EditorConfig settings, where you can set some custom variables or overwrite existing properties.
web-mode has several variables for indentation offset size and
EditorConfig sets them at once by
indent_size. You may want to stop indenting
only blocks of
web-mode: it can be achieved by adding following to your init.el:
(add-hook 'editorconfig-after-apply-functions (lambda (props) (setq web-mode-block-padding 0)))
You can also define your own custom properties and enable them here.
A list of function to alter property values before applying them.
These functions will be run after loading ".editorconfig" files and before applying them to current buffer, so that you can alter some properties from ".editorconfig" before they take effect.
For example, Makefiles always use tab characters for indentation: you can
overwrite "indent_style" property when current
major-mode is a
makefile-mode with following code:
(add-hook 'editorconfig-hack-properties-functions '(lambda (props) (when (derived-mode-p 'makefile-mode) (puthash 'indent_style "tab" props))))
Alist of indentation setting methods by modes.
For the easiest case to add a new support for a major-mode, you just need to add a pair of major-mode symbol and its indentation variables:
(add-to-list 'editorconfig-indentation-alist ;; Just an example, of course EditorConfig has already included this setting! '(c-mode c-basic-offset))
Buffer local minor-mode to use to trim trailing whitespaces.
If set, enable/disable that mode in accord with
Otherwise, use Emacs built-in
One possible value is
ws-butler-mode, with which
only lines touched get trimmed. To use it, add following to your
(setq editorconfig-trim-whitespaces-mode 'ws-butler-mode)
Submitting Bugs and Feature Requests
Bugs, feature requests, and other issues should be submitted to the issue tracker: https://github.com/editorconfig/editorconfig-emacs/issues
Make and CMake must be installed to run the tests locally:
$ make test
EditorConfig Emacs Plugin is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.