explaingit

jxs/editorconfig-emacs

Analysis updated 2026-07-09 · repo last pushed 2017-09-12

Emacs LispAudience · developerComplexity · 2/5DormantSetup · easy

TLDR

An Emacs plugin that automatically applies your project's shared formatting rules, like indentation style, line endings, and trailing whitespace, whenever you open a file, so your whole team stays consistent without manual setup.

Mindmap

mindmap
  root((repo))
    What it does
      Reads editorconfig files
      Adjusts Emacs settings
      Built-in fallback support
    Tech stack
      Emacs Lisp
      EditorConfig core
    Use cases
      Team formatting consistency
      Cross-editor compatibility
      Open source contributions
    Audience
      Emacs users
      Teams with mixed editors
      Open source maintainers
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Ensure your whole team uses the same indentation and formatting rules across different editors.

USE CASE 2

Automatically apply project-specific formatting conventions when opening files in Emacs.

USE CASE 3

Let open-source contributors follow your project's formatting rules without manual editor configuration.

What is it built with?

Emacs LispEditorConfig

How does it compare?

jxs/editorconfig-emacsnohzafk/emacs-workspace-hudemacs-evil/evil
Stars173,763
LanguageEmacs LispEmacs LispEmacs Lisp
Last pushed2017-09-12
MaintenanceDormant
Setup difficultyeasyhardeasy
Complexity2/53/52/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Install the plugin via MELPA or manually load it, no external EditorConfig program is required due to the built-in fallback.

You can use, modify, and distribute this software freely, including for commercial use, as long as you include the copyright notice.

In plain English

EditorConfig Emacs Plugin makes your Emacs editor automatically follow consistent formatting rules, like how many spaces to use for indentation, whether to use tabs or spaces, and whether to trim trailing whitespace, based on a simple configuration file checked into your project rather than your personal editor settings. This means a whole team can share the same formatting conventions without anyone needing to manually configure their editor for each project. The way it works is straightforward: a project includes a small file called .editorconfig that lists formatting preferences (like "indent with 4 spaces" or "use Unix-style line endings"). When you open a file in Emacs, this plugin reads that file and adjusts Emacs's settings accordingly for that buffer. The plugin can use an external EditorConfig program if you have it installed, but it also has a built-in fallback written in Emacs Lisp, so it works even without installing anything extra. It supports common rules like indent style, indent size, line endings, character encoding, trailing whitespace trimming, and maximum line length. This is useful for anyone working on a team where people use different editors but need consistent code formatting. For example, if one developer uses Emacs and another uses VS Code, both can read the same .editorconfig file and produce code that follows identical formatting rules. It's also handy for open-source maintainers who want contributors to follow project conventions without writing lengthy setup instructions. One notable detail: the plugin doesn't fully enforce every rule yet. For instance, it can stop Emacs from automatically adding a final newline to files, but it won't remove existing trailing newlines from files that should have none. There's also a customizable hook system that lets you override or extend settings for specific editing modes, useful when a particular Emacs mode has its own indentation behavior that doesn't play nicely with the defaults.

Copy-paste prompts

Prompt 1
How do I set up the EditorConfig Emacs plugin to automatically handle indentation and trailing whitespace for my project?
Prompt 2
Write an .editorconfig file that enforces 4-space indentation, Unix line endings, and no trailing whitespace for a JavaScript project.
Prompt 3
How can I use the customizable hook system in editorconfig-emacs to override indentation settings for a specific Emacs mode like Python?

Frequently asked questions

What is editorconfig-emacs?

An Emacs plugin that automatically applies your project's shared formatting rules, like indentation style, line endings, and trailing whitespace, whenever you open a file, so your whole team stays consistent without manual setup.

What language is editorconfig-emacs written in?

Mainly Emacs Lisp. The stack also includes Emacs Lisp, EditorConfig.

Is editorconfig-emacs actively maintained?

Dormant — no commits in 2+ years (last push 2017-09-12).

What license does editorconfig-emacs use?

You can use, modify, and distribute this software freely, including for commercial use, as long as you include the copyright notice.

How hard is editorconfig-emacs to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is editorconfig-emacs for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.