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
See the EditorConfig documentation for a detailed description of the .editorconfig
file format.
- Open a project containing an
.editorconfig
file. - 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. - 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.
- 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 commandEditorConfig: 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 theEditorConfig: Fix File
command on each malformed file. Keep in mind that malformed files (especially mixed tab characters) may lead to unexpected behaviour.
root
charset
end_of_line
indent_style
indent_size
/tab_width
(indent_size
takes precedence overtab_width
)insert_final_newline
(setting this tofalse
strips final newlines)max_line_length
trim_trailing_whitespace
π‘ Any malformed or missing property falls back to
unset
which leaves the control to Atom.
β οΈ Atom does not support CR line-endings. Whenend_of_line
is set tocr
, EditorConfig will respect the setting when saving files, but their contents will appear to be squashed onto a single line.
EditorConfig: Fix File
: Fixesindent_style
andend_of_line
issues for the current editor.EditorConfig: Fix File Quietly
: Same asFix File
, except no feedback is displayed after fixing.EditorConfig: Show State
: Shows the current state of EditorConfig for your current editor.EditorConfig: Generate Config
: Generates an initial.editorconfig
for your project.
- Applies the settings from your
.editorconfig
file - Ability to fix
indent_style
andend_of_line
issues - Syntax highlights
.editorconfig
files (now with specification-like case insensitivity) - Lint
.editorconfig
file - Ability to generate an
.editorconfig
file based on the current settings - Displays a nifty π in the statusBar whose color shows you if EditorConfig faces any problems
- Clicking on the π invokes the
Show State
command for you - Recognizes if you save any
.editorconfig
file and reapplies all settings to all opened editor-panes
root = true
[*]
indent_style = tab
indent_size = 3
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.{json,yml}]
indent_size = 2
[*.md]
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:
- Why isn't EditorConfig applying the indentation character to my files?
EditorConfig is not intended to do so; it will apply the indentation char only to new indentations. You may try to fix indentation issues with theEditorConfig: Fix File
command. - Why is
indent_style
not working?
You can set Atom's config setting "Tab Type" to eithersoft
orhard
, this prevents EditorConfig from influencing the indentation style. Set Atom's "Tab Type" toauto
to allow EditorConfig taking control over the indentation characters. - Why is feature X not working?
Some other packages (e.g. thewhitespace
package) override the EditorConfig settings. In these cases, we try to alert you about confirmed interferences and suggest that you try disabling the other package. If you face any unreported issues, please let us know.
π‘ 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 theShow State
command).
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