editorconfig files, and pass back the properties that should be used. The EditorConfig core libraries accept as input the file being edited, find and parse relevant. Create a pluginĮditorConfig plugins can be developed by using one of the EditorConfig core libraries. Please use the mailing list to send an email to the EditorConfig team (subscribe by shooting an email to and use the issue tracker to submit bugs (but please take a look at the FAQ first). We want to hear ideas about how to make this project better. This project is greatly in need of feedback from other developers. Everything should just work.Ĭontributing to EditorConfig Give us your feedback These editors come bundled with native support for EditorConfig. Additionally, if a property is not standardized in your project ( end_of_line for example), it may be best to leave it blank. Also, when indent_style is set to tab, it may be desirable to leave indent_size unspecified so readers may view the file using their preferred indentation width. For example, tab_width need not be specified unless it differs from the value of indent_size. It is acceptable and often preferred to leave certain EditorConfig properties unspecified. For example, add indent_size = unset to undefine indent_size property (and use editor default). For any property, a value of unset is to remove the effect of that property, even if it has been set before. EditorConfig takes no effect on that part. Generally, if a property is not specified, the editor settings will be used, i.e. editorconfig files search on current file.Ĭurrently all properties and values are case-insensitive.

root: special property that should be specified at the top of the file outside of any sections.

insert_final_newline: set to true to ensure file ends with a newline when saving and false to ensure it doesn't.

trim_trailing_whitespace: set to true to remove any whitespace characters preceding newline characters and false to ensure it doesn't.

charset: set to latin1, utf-8, utf-8-bom, utf-16be or utf-16le to control the character set.

end_of_line: set to lf, cr, or crlf to control how line breaks are represented.

This defaults to the value of indent_size and doesn't usually need to be specified.

tab_width: a whole number defining the number of columns used to represent a tab character.When set to tab, the value of tab_width (if specified) will be used. indent_size: a whole number defining the number of columns used for each indentation level and the width of soft tabs (when supported).indent_style: set to tab or space to use hard tabs or soft tabs respectively.The wiki has a complete list of properties. Note that not all properties are supported by every plugin. Special characters can be escaped with a backslash so they won't be interpreted as wildcard patterns. Matches any integer numbers between num1 and num2, where num1 and num2 can be either positive or negative Matches any of the strings given (separated by commas) ( Available since EditorConfig Core 0.11.0) Matches any string of characters, except path separators ( /) Special characters recognized in section names for wildcard matching: * EditorConfig files are read top to bottom and the most recent rules found take precedence.įilepath glob patterns and currently-supported EditorConfig properties are explained below. EditorConfig files should be UTF-8 encoded, with either CRLF or LF line separators. Only forward slashes ( /, not backslashes) are used as path separators and octothorpes ( #) or semicolons ( ) are used for comments. The section names are filepath globs (case sensitive), similar to the format accepted by gitignore. File Format DetailsĮditorConfig files use an INI format that is compatible with the format used by Python ConfigParser Library, but are allowed in the section names. (note the trailing dot), which Windows Explorer will automatically rename to. editorconfig file within Windows Explorer, you need to create a file named. Properties from matching EditorConfig sections are applied in the order they were read, so properties in closer files take precedence.įor Windows Users: To create an. editorconfig files will stop if the root filepath is reached or an EditorConfig file with root=true is found.ĮditorConfig files are read top to bottom and the most recent rules found take precedence. editorconfig in the directory of the opened file and in every parent directory. When opening a file, EditorConfig plugins look for a file named. indent_style = space indent_size = 2Ĭheck the Wiki for some real-world examples of projects using EditorConfig files.

end_of_line = lf insert_final_newline = true # Matches multiple files with brace expansion notation

Root = true # Unix-style newlines with a newline ending every file

Emacs auto indent