EditorConfig

From Wikipedia the free encyclopedia

Type of formatINI configuration file
Standardhttps://spec.editorconfig.org/
Open format?true
Free format?true
Websitehttps://editorconfig.org/

EditorConfig is an open specification and file format for Syntax highlighting, text editors and integrated development environment (IDEs) that aims to maintain a consistent coding style, particularly aimed at groups working together.[1][2] It can help keep multiple editors as well as individuals using the same conventions. It stores configurations in a file which can be shared by multiple people or used in multiple editors (by the same person or by many).[3][4] It defines rules for how to format different programming languages or other structured text files with conventions such as what character to end a line with and how to manage indentation.[5]

Concept[edit]

The project web site states "EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems."[6]

Specification[7][edit]

The configuration is typically stored in a UTF-8 encoded text file: .editorconfig. Some tools allow saving their style preferences as an EditorConfig file.[8] Each line:

  • May be blank (only Whitespace characters
  • A comment that begiings with ; or #
  • A section header, which starts with a square bracket [, and ends with a square bracket ].
    • A sectionheader may not have any non-whitespace characters outside of the brackets
    • It may contain any characters between the backets including whitespace/tabs
    • It uses forward slash characters / as path separators
      • Backslashes \ are prohibited, even on Windows.
  • Key-Value pair, with a = separating the key from the value

Any other line format is invalid. It does not support in-line comments. If there is a ; or # character anywhere other than the start of line it is considered to be part of the text of the line. It does not support any character escaping.

Parts/sections of file[edit]

  • Preamble: optional key=value pairs that precede the first section.
  • Section Name: String between [ ]
  • Section: the key value pairs that follow a section name until the start of the next section.

glob expressions[edit]

Section names are file path globs, using a format similar to .gitignore, and are based on Unix convetions.

File name globs
characters matched files
* Any string (of any length) except path separators (/
** Any string of characters
? Any single character
[seq] Any single character in the seq
[!seq] Any single character not in seq
{s₁,s₂,..sₙ} Any of the comma-separated list of strings. This can be nested. There must be more than one string in the list, as {somestring} will match the literal value '{somestring}' (which is probably not what was intended).
{n₁..n₂} Matches an integer number between n₁ and n₂ (i.e. matches i∈ℤ∣n₁≤i≤n₂)

File location[edit]

EditorConfig plugins look for a file named .editorconfig in the same directory that contains an existing file, and in parent directories of that one until it hits the root filepath (e.g. / in Linux/Unix/MacOS or C: in the case of Microsoft Windows, or it finds an .editorconfig file that contains a line that states root=true.

The most recent rules found take precedence in the order they are read. So rules in the same directory as the file would over-rule rules from higher level directories.

File format[edit]

Editor config uses the common INI configuration file format.

Style options[edit]

Configuration options
Key Settings to configure the option
indent_style Set to use "tab" or "space" to use tab characters or spaces
indent_size Integer that defines how many spaces per tab, or how wide a tab stop is.
tab_width This usually isn't specified as it defaults to the indent_size
end_of_line set to "lf" , "cr", or "crlf" to control how line breaks are represented.
charset Character encoding "latin1", "utf-8", "utf-8-bom", "utf-16be" or "utf-16le" to control the character set.
trim_trailing_whitespace if set to "true" will remove any whitespace characters preceding newline characters
insert_final_newline if "true" will end files with a newline, "false" will prevent it.
root special property (e.g. specified at the top of the file outside of any sections). Set to "true" to stop .editorconfig files search on current file. (I.e. don't keep looking for any more EditorConfig files in higher level directories.

Some tools support additional options such as max_line_length (which forces a hard line wrap after the specified number of characters) (supported by Emacs, Vim, Atom, and several others)

Implementation[edit]

Many popular editors have adopted support of the specification.[9] The GitHub page for the project has libraries written in GO programing language,[10] C programing language,[11] and Python programming language,[12] and there is a Node.JS library as well.[13] There is a comprehensive listing of editors available on the project site.[14]

Editors reported to work without use of a plug-in[edit]

Gitea, GitHub, IntellijIdea,[15] PyCharm, and editors by JetBrains,[16] Kate, Komodo, Visual Studio, Vim/Neovim.

Editors which require a plug-in[edit]

Some editors require installation of a plug-in: Eclipse IDE, Atom, Emacs, Geany, JEdit, Notepad++, Netbeans, Visual Studio Code,[17] Sublime Text

Build environment which require a plug-in[edit]

Apache Ant, Gradle, Apache Maven

Editors which don't support EditorConfig[edit]

There is no list maintained of all the various text editors or IDEs which do not support EditorConfig (e.g. Spyder IDE[18] has had support mentioned in the past, but does not seem to yet include it.[19][20]

Other software development tools which implement EditorConfig[edit]

Prettier[21]

References[edit]

  1. ^ Hombergs, Tom (2021-02-15). "Painless Code Formatting with EditorConfig". reflectoring.io. Retrieved 2024-04-24.
  2. ^ "Define consistent coding styles with EditorConfig". Microsoft Build. Microsoft. April 2024. Retrieved April 1, 2024.
  3. ^ "EditorConfig". X (Formerly known as Twitter). Retrieved 24 April 2024.
  4. ^ The Codeholic. "What is .editorconfig - EditorConfig full Guide". YouTube. Retrieved 24 April 2024.
  5. ^ "Configuration files for code analysis rules". Microsoft Build. 6 October 2023. Retrieved 24 April 2024.
  6. ^ ""EditorConfig"". EditorConfig. Retrieved 23 April 2024.
  7. ^ ""EditorConfig Specification"". Retrieved 24 April 2024.
  8. ^ "Code style options and code cleanup - Visual Studio (Windows)". 15 May 2023.
  9. ^ ""What is .editorconfig ?"". Geeks for Geeks. 7 March 2024. Retrieved 24 April 2024.
  10. ^ "Editorconfig/Editorconfig-core-go". GitHub. Retrieved 24 April 2024.
  11. ^ "Editorconfig/Editorconfig-core-c". GitHub. Retrieved 24 April 2024.
  12. ^ "Editorconfig/Editorconfig-core-py". GitHub. Retrieved 24 April 2024.
  13. ^ "Editorconfig". 2 July 2023. Retrieved 24 April 2024.
  14. ^ "Projects Using EditorConfig". GitHub. Retrieved 2024-04-24.
  15. ^ "EditorConfig | IntelliJ IDEA".
  16. ^ "EditorConfig - IntelliJ IDEs Plugin | Marketplace". Retrieved 24 April 2024.
  17. ^ "EditorConfig for VS Code - Visual Studio Marketplace". Retrieved 24 April 2024.
  18. ^ "Add support for .editorconfig #2464". Syder-ide Github. June 2, 2015.
  19. ^ "'EDITORCONFIG' environmental variable for global config · Issue #465 · editorconfig/Editorconfig". GitHub. Retrieved 24 April 2024.
  20. ^ "Editor — Spyder 5 documentation". Retrieved 24 April 2024.
  21. ^ "How I Setup ESLint, Prettier, and EditorConfig for Static Sites". DEV Community. 2022-01-25. Retrieved 2024-04-24.
Retrieved from "https://en.wikipedia.org/w/index.php?title=EditorConfig&oldid=1221957671"