Skip to content
EditorConfig plugin for Emacs
Emacs Lisp Makefile
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin 2020 Jan 16, 2020
core-test @ 48610d4 Update core-test Oct 23, 2019
doc Fix typos (#212) Nov 27, 2019
ert-tests Update plugin-tests submodule Jan 24, 2019
.editorconfig Use file_type_ext for test fixtures Sep 25, 2018
.gitignore Minor changes Aug 31, 2015
.gitmodules Add plugin-tests submodule Jan 3, 2017
.travis.yml Use dist: trusty Oct 8, 2019
CHANGELOG.md Keep a CHANGELOG (#221) May 22, 2020
CONTRIBUTORS CONTRIBUTORS: Add @zbeekman for Fortran90+ support Jul 3, 2019
LICENSE Minor changes Aug 31, 2015
Makefile Do not update submodule when running tests Jan 24, 2019
README.md Update README Dec 20, 2019
editorconfig-conf-mode.el Add conf-mode abbrev-table definitions (#220) May 19, 2020
editorconfig-core-handle.el 2020 Jan 16, 2020
editorconfig-core.el 2020 Jan 16, 2020
editorconfig-fnmatch.el 2020 Jan 16, 2020
editorconfig.el Merge branch 'master' into defaultcore May 18, 2020

README.md

Build Status MELPA MELPA Stable

EditorConfig Emacs Plugin

This is an EditorConfig plugin for Emacs.

Setup

This package is available from MELPA and MELPA Stable. Install from there and enable global minor-mode editorconfig-mode:

(editorconfig-mode 1)

If you use use-package, add the following to your init.el file:

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

(Optional) Install a Core Program

This package uses a Core program. A core implemented in Emacs Lisp is include in this plugin, so usually you don't need to install any other core programs.

Optionally, you can install and use other core programs. One such example is EditorConfig C Core, follow the instructions in the README and INSTALL files to install it. To use them instead of the default elisp core, you need to configure editorconfig-get-properties-function (read the docstring for details).

Supported properties

Current Emacs plugin coverage for EditorConfig's properties:

  • indent_style
  • indent_size
  • tab_width
  • end_of_line
  • charset
  • trim_trailing_whitespace
  • insert_final_newline = true is supported
  • insert_final_newline = false 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 .editorconfig marks as trailing-newline-free
  • max_line_length
  • file_type_ext (Experimental)
  • file_type_emacs (Experimental)
  • root (only used by EditorConfig core)

Not yet covered properties marked with over-strike – 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, indentation, 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.

File Type

This plugin has experimental supports for file_type_ext and 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 md for a.txt, for example, major-mode will be decided as if the file name would be a.txt.md (and thus markdown-mode is likely to be used).

file_type_emacs When it is set to markdown for a.txt, markdown-mode will be enabled when opening a.txt.

These property are experimental and their meanings might change in the future updates. When both are specified, file_type_ext takes precedence.

Customize

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

editorconfig-after-apply-functions

(Formerly editorconfig-custom-hooks)

A list of functions after loading common EditorConfig settings, where you can set some custom variables or overwrite existing properties.

For example, 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.

editorconfig-hack-properties-functions

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

editorconfig-indentation-alist

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

editorconfig-trim-whitespaces-mode

Buffer local minor-mode to use to trim trailing whitespaces.

If set, enable/disable that mode in accord with trim_trailing_whitespace property in .editorconfig. Otherwise, use Emacs built-in delete-trailing-whitespace function.

One possible value is ws-butler-mode, with which only lines touched get trimmed. To use it, add following to your init.el:

(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

Development

Make and CMake must be installed to run the tests locally:

$ make test

License

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

You can’t perform that action at this time.