EditorConfig
An INI-like .editorconfig file, read from the file's directory upward, that tells any editor the indentation, line endings, charset and whitespace rules of a project.
Canonical text: https://editorconfig.org/, read against version 0.17.2. In use on this site: github.com/manifesto-md/manifesto.md/blob/main/.editorconfig.
The file format
- EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
- EditorConfig files are easily readable and they work nicely with version control systems.
- An EditorConfig file is named ".editorconfig", all lowercased; plugins look for it in the directory of the opened file and in every parent directory.
- The search shall stop if the root filepath is reached or an EditorConfig file is found with the root key set to true in the preamble.
- Properties from matching EditorConfig sections are applied in the order they were read, so properties in closer files take precedence.
- EditorConfig files are in an INI-like file format; section names are filepath globs, similar to the format accepted by .gitignore, and are case sensitive.
- Currently all properties and values are case-insensitive.
- For any pair, a value of unset removes the effect of that pair, even if it has been set before.
- indent_style: set to tab or space to use hard tabs or soft tabs respectively.
- indent_size: a whole number defining the number of columns used for each indentation level.
- tab_width: a whole number defining the number of columns used to represent a tab character.
- end_of_line: set to lf, cr, or crlf to control how line breaks are represented.
- charset: set to latin1, utf-8, utf-8-bom, utf-16be or utf-16le to control the character set.
- trim_trailing_whitespace: set to true to remove any whitespace characters preceding newline characters.
- insert_final_newline: set to true to ensure file ends with a newline when saving.
- root: special property that should be specified at the top of the file outside of any sections.
- It is acceptable and often preferred to leave certain EditorConfig properties unspecified.
Facts
- Maintainer
- EditorConfig Team
- Repository
- https://github.com/editorconfig/specification
- Licence of the text
- BSD-2-Clause
- Status of the text
- stable
- Listing
- listed, not yet claimed
Read with
-
Conventional Commits
A lightweight convention on top of commit messages, type, scope and description, that machines and people can read and that maps onto semantic versions.
Badge
[](https://manifesto.md/editorconfig/) Maintainers claim a listing with a pull request setting listing: claimed, or a yes on the listing issue.