Helps developers maintain consistent coding styles between different editors

Sindre Sorhus






This package provides the following services:

This package consumes the following services:


Build status: TravisCI Build status: AppVeyor Latest package version

EditorConfig helps developers maintain consistent coding styles between different editors.

"I will take a peanut butter sandwich on white bread" -- Ralph S. Mouse


$ apm install editorconfig

Or, Settings → Install → Search for editorconfig

Getting started

See the EditorConfig documentation for a detailed description of the .editorconfig file format.

  1. Open a project containing an .editorconfig file.
  2. Whenever you open a file in the project (or change any .editorconfig file from within Atom), EditorConfig evaluates the EditorConfig settings for the current file.
  3. EditorConfig then applies these settings to your current editor pane. Any change you make from now on will follow the EditorConfig settings. EditorConfig does not automatically fix older files it considers as malformed.
  4. You can always check your EditorConfig settings against the current file using the EditorConfig: Show State command. You can try to fix malformed files using the command EditorConfig: Fix File.

💡 If EditorConfig detects any issues which may prevent it from working properly a 🐭 will appear in the status bar; click on it to open the state notification.

⚠️ EditorConfig will not automatically fix malformed files (e.g. change all soft tabs to hard tabs) -- you need to use the EditorConfig: Fix File command on each malformed file. Keep in mind that malformed files (especially mixed tab characters) may lead to unexpected behaviour.

Supported properties

💡 Any malformed or missing property falls back to unset which leaves the control to Atom.

⚠️ Atom does not support CR line-endings. When end_of_line is set to cr, EditorConfig will respect the setting when saving files, but their contents will appear to be squashed onto a single line.

EditorConfig commands


Example file

root = true

indent_style = tab
indent_size = 3
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

indent_size = 2

trim_trailing_whitespace = false


See changelog.md.


We're sorry to hear you're having trouble using atom-editorconfig! Please bear some caveats in mind:

💡 You can check how EditorConfig affects your current file by invoking the EditorConfig: Show State command. If EditorConfig detects any issues which may prevent it from working properly it displays a 🐭 in the status bar; clicking on it opens the state notification (like the Show State command).

Help us get better

We would be happy to hear from you -- please report any feedback, issues or ideas. Thank you! 💝

💝 We thank our contributors for their amazing work to make Atom support editorconfig!




MIT © Sindre Sorhus