Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.14 KB

README.md

File metadata and controls

55 lines (41 loc) · 2.14 KB
Raw

EditorConfig Emacs Plugin

This is an EditorConfig plugin for Emacs.

Installation

Download the EditorConfig core and follow the instructions in the README and INSTALL files to install it.

Once EditorConfig core is installed, copy editorconfig.el to ~/.emacs.d/lisp and add the following to your ~/.emacs file:

(add-to-list 'load-path "~/.emacs.d/lisp")
(load "editorconfig")

Alternatively, you can find the package available on Marmalade.

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
  • root (only used by EditorConfig core)

Not yet covered properties marked with over-strike – pull requests implementin 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.

Submitting Bugs and Feature Requests

Bugs, feature requests, and other issues should be submitted to the main EditorConfig issue tracker: https://github.com/editorconfig/editorconfig/issues