EditorConfig

The Manifesto

• You need a code style

  I don't care what style you use, but please pick a style and use it consistently.

• Your code, your rules

  If I contribute code to your project I must obey the existing code style.

• Don't argue about tabs and spaces

  It's 2015. Your text editor should be handling this for you.

• Everything should be automated

  Tabs, spaces, whatever. Let the computer figure it out.

The Solution: EditorConfig

1. Add an .editorconfig file

   Drop an .editorconfig file in your project. This specifies the code style for your files.

2. Download an EditorConfig plugin

   Download an EditorConfig plugin for your text editor.

3. Problem solved

   Really, that's it. You've just trained your editor to keep you in line.

Example

Libraries and Tools

• EditorConfig Libraries

  • C, C++, C#, Objective C
  • JavaScript
  • Java
  • Python
  • Ruby

• EditorConfig support for Code Painter JS beautifier

  https://github.com/jedhunsaker/codepainter

• EditorConfig conformance checker

  https://github.com/treyhunner/editorconfig-tools

Native Editor Support

• BBEdit
• Coda
• CLion
• GitHub
• intelliJ
• RubyMine
• SourcLair
• WebStorm

Editor Plugin Support

• WebStorm
• Sublime Text
• Atom
• Brackets
• GitHub
• Komodo
• Emacs
• Visual Studio
• Notepad++
• Vim
• Xcode
• PyCharm
• PHPStorm
• TextMate
• RubyMine
• Eclipse
• Gedit
• NetBeans
• jEdit
• Geany
• Code::Block
• CLion
• intelliJ
• Coda

Who Uses This?

• jQuery
• Ember.js
• AngularJS
• Bootstrap
• Foundation
• HTML5 Boilerplate
• Gulp
• Ionic
• lodash
• Wordpress
• Bower
• Django
• Ghost
• CakePHP
• Symfony2
• Drupal
• Ruby
• Yeoman
• ZSH

Future Goals

• Support for even more editors

  • Wing IDE
  • Dreamweaver
  • Your favorite editor

• Built-in support in even more editors

How You Can Help

• Spread .editorconfig files everywhere

  Put them in your own projects and contribute them to your favorite open source projects.

• Create a plugin for another text editor or IDE

  Or open an open source bounty to help fund the development.

• Join the mailing list, IRC channel, and bug tracker

  Watch the progress, state your opinions, and chat with us