Meta tags:

Headings (most frequently used words):

editorconfig, file, specification, of, introduction, informative, terminology, format, glob, expressions, processing, supported, pairs, indentation, non, normative, suggestions, for, plugin, developers, versioning, empty, files, no, inline, comments, parts, an, capitalization, the, name, navigation, related, topics,

Text of the page (most frequently used words):
the (157), editorconfig (62), and (47), file (43), with (32), for (31), are (28), this (26), #version (22), not (21), any (21), files (20), specification (19), that (19), all (18), value (18), section (17), line (17), tab (16), indent_size (16), pairs (16), must (15), indentation (15), key (14), characters (13), set (13), core (12), character (12), one (11), may (11), true (10), lines (10), values (10), cores (9), used (9), case (9), tabs (9), directory (9), plugins (8), example (8), can (8), tab_width (8), root (8), format (8), editors (7), given (7), when (7), specified (7), indent_style (7), insensitive (7), have (6), numbers (6), those (6), each (6), tests (6), same (6), beginning (6), plugin (6), spaces (6), only (6), but (6), keys (6), pair (6), lowercased (6), empty (6), utf (6), supported (6), glob (6), number (5), repository (5), read (5), because (5), level (5), columns (5), following (5), should (5), single (5), non (5), even (5), use (5), filename (5), whitespace (5), defined (5), take (5), informative (5), name (5), matching (5), from (5), contains (5), path (5), separators (5), comment (5), own (4), where (4), possible (4), therefore (4), above (4), how (4), two (4), special (4), normative (4), accept (4), define (4), upper (4), editor (4), preamble (4), does (4), charset (4), shall (4), found (4), sections (4), changed (4), named (4), opening (4), some (4), capitalization (4), names (4), matches (4), pattern (4), globs (4), subdir (4), brackets (4), between (4), num2 (4), num1 (4), literally (4), seq (4), string (4), comments (4), blank (4), include (4), source (3), documentation (3), their (3), also (3), versioning (3), developers (3), indented (3), other (3), than (3), placing (3), consequent (3), required (3), still (3), space (3), comes (3), size (3), means (3), code (3), next (3), then (3), width (3), equal (3), respectively (3), choose (3), its (3), after (3), settings (3), ensure (3), ends (3), false (3), language (3), either (3), control (3), defining (3), contain (3), separated (3), filesystem (3), different (3), precedence (3), multiple (3), they (3), leading (3), inside (3), below (3), end (3), considered (3), see (3), expressions (3), header (3), first (3), parts (3), allowed (3), inline (3), part (3), text (3), styles (3), related (2), vimscript (2), pass (2), process (2), report (2), numbering (2), follows (2), semver (2), has (2), suggestions (2), statement (2), fit (2), return (2), def (2), understand (2), let (2), another_file (2), less (2), achieved (2), via (2), order (2), applicable (2), what (2), whenever (2), consider (2), snippet (2), equals (2), many (2), previous (2), soft (2), specify (2), behavior (2), including (2), 1024 (2), beyond (2), implementation (2), limits (2), explicit (2), effect (2), before (2), defaults (2), unset (2), newline (2), saving (2), doesn (2), insert_final_newline (2), remove (2), property (2), letter (2), spelling_language (2), iso (2), there (2), bom (2), crlf (2), whole (2), need (2), which (2), filled (2), rest (2), invalid (2), valid (2), such (2), platform (2), thus (2), closer (2), search (2), directories (2), processing (2), limit (2), ending (2), match (2), slash (2), square (2), except (2), filepath (2), these (2), parse (2), txt (2), foo (2), trailing (2), starts (2), ignored (2), bundle (2), people (2), conforming (2), update (2), terminology (2), coding (2), project (2), introduction (2), 2019, 2024, team, powered, page, alabaster, sphinx, overview, topics, navigation, supporting, independent, switch, versions, might, respond, semantic, tagged, corresponds, applies, todo, now, please, github, wiki, guidelines, condition, cannot, hand, func, way, works, look, additionally, expect, will, since, another, achievable, comply, configuration, new, achieving, overreaching, although, supplement, fulfill, requirement, precisely, example_file, into, picture, specifies, achieve, fully, actually, living, setting, indent, relation, course, question, print, split, important, execute, options, require, lengths, 4096, parsing, removes, been, add, undefine, tell, check, higher, current, insert, newlines, preceding, trim_trailing_whitespace, separate, note, territory, identifier, five, long, 3166, 639, sets, natural, spell, checking, default, discouraged, 16le, 16be, latin1, breaks, represented, end_of_line, represent, usually, else, option, implies, hard, explanation, indentation_, here, list, associated, them, ignore, unrecognized, unsupported, syntactically, sign, exception, located, under, common, exists, api, opens, differently, capitalized, described, paragraph, prevent, additional, operation, specifically, retrieving, relatively, expensive, context, noted, platforms, results, addition, were, top, bottom, most, recent, within, later, over, earlier, last, performed, parent, existing, treated, exist, searched, stop, reaching, length, backslash, escape, interpreted, corollary, relevant, already, middle, yield, result, separator, relative, particular, itself, otherwise, stores, however, integer, positive, negative, instance, strings, commas, nested, well, similar, accepted, support, through, unix, shell, style, wildcards, recognize, wildcard, gitignore, starting, until, precedes, optional, formerly, mark, led, confusion, containing, old, parsers, allow, compatibility, escaping, mechanism, gives, variable, anywhere, start, equivalent, encoded, provided, python, trimmed, backslashes, windows, forward, slashes, nothing, types, remaining, type, ini, like, time, rely, external, functionality, come, direct, interaction, organization, permit, editing, being, edited, receive, based, provide, lowercase, storing, conform, helps, maintain, consistent, working, across, various, ides, consists, collection, enable, adhere, easily, readable, work, nicely, systems, content, document, unless, marked, table, contents,

Text of the page (random words):
editorconfig specification editorconfig specification 0 17 2 documentation editorconfig specification this is version 0 17 2 of this specification table of contents editorconfig specification introduction informative terminology file format empty editorconfig files no inline comments parts of an editorconfig file glob expressions file processing capitalization of the file name supported pairs indentation non normative suggestions for plugin developers versioning introduction informative all content in this document is normative unless marked informative 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 terminology changed in version 0 15 1 in editorconfig editorconfig files named editorconfig in lowercase include section s storing key value pairs editorconfig files must conform to this specification cores parse files conforming to this specification and provide key value pairs to plugins plugins receive key value pairs from cores and update an editor s settings based on the key value pairs editors permit editing files and use plugins to update settings for files being edited a conforming core or plugin must pass the tests in the core tests repository or plugin tests repository respectively informative some plugins include or bundle their own cores and some rely on external cores some editors include or bundle plugin or core functionality editors plugins and cores may all come from different people those people may or may not have any direct interaction with the editorconfig organization file format changed in version 0 17 2 editorconfig files are in an ini like file format to read an editorconfig file take one line at a time from beginning to end for each line remove all leading and trailing whitespace process the remaining text as specified for its type below the types of lines are blank contains nothing blank lines are ignored comment starts with a or a comment lines are ignored section header starts with a and ends with a these lines define globs see glob expressions may contain any characters between the square brackets e g and and even spaces and tabs are allowed forward slashes are used as path separators backslashes are not allowed as path separators even on windows key value pair or pair contains a key and a value separated by an see supported pairs key the part before the first on the line value the part if any after the first on the line keys and values are trimmed of leading and trailing whitespace but include any whitespace that is between non whitespace characters if a value is not provided then the value is an empty string i e in c or python any line that is not one of the above is invalid editorconfig files must be utf 8 encoded with lf or crlf line separators empty editorconfig files an empty editorconfig file contains only blank and comment lines or no lines at all it is equivalent to an editorconfig file that contains only one line root false no inline comments changed in version 0 15 0 a or anywhere other than at the beginning of a line does not start a comment but is part of the text of that line for example txt foo editorconfig gives variable foo the value editorconfig in txt files not the value editorconfig this specification does not define any escaping mechanism for or characters compatibility the editorconfig file format formerly allowed the use of and after the beginning of the line to mark the rest of a line as comment this led to confusion how to parse values containing those characters old editorconfig parsers may still allow inline comments parts of an editorconfig file the parts of an editorconfig file are preamble the lines that precedes the first section the preamble is optional and may contain key value pairs comments and blank lines section name the string between the beginning and the ending section the lines starting from a section header until the beginning of the next section header or the end of the file glob expressions section names in editorconfig files are filepath globs similar to the format accepted by gitignore they support pattern matching through unix shell style wildcards these filepath globs recognize the following as special characters for wildcard matching special characters matching any string of characters except path separators any string of characters any single character except path separators seq any single character in seq any character inside those brackets is considered literally it means that pattern ab c 1 2 is considered literally either a or b or or c or or 1 or or 2 or seq any single character not in seq any character inside those brackets is considered literally as well see example above s1 s2 s3 any of the strings given separated by commas can be nested but s1 only matches s1 literally num1 num2 any integer numbers between num1 and num2 where num1 and num2 can be either positive or negative num1 is required to be less than num2 for instance 1 3 1 4 are valid but 4 5 3 1 are not if the glob contains a path separator a not inside square brackets then the glob is relative to the directory level of the particular editorconfig file itself otherwise the pattern may also match at any level below the editorconfig level for example c matches any file that ends with c in the directory of editorconfig or any other directory below one that stores this editorconfig however the glob subdir c only matches files that end with c in the subdir directory in the directory of editorconfig therefore a leading slash is not relevant if there is already a slash in the middle of the pattern thus the globs subdir c and subdir c must yield the same result as a corollary a section name ending with does not match any file the backslash character can be used to escape a character so it is not interpreted as a special character cores must accept section names with length up to and including 1024 characters beyond that each implementation may choose to define its own upper limit or no explicit upper limit at all file processing when a filename is given to editorconfig a search is performed in the directory of the given file and all parent directories for an editorconfig file an editorconfig file is named editorconfig all lowercased non existing directories are treated as if they exist and are empty all found editorconfig files are searched for sections with section names matching the given filename the search shall stop if an editorconfig file is found with the root key set to true in the preamble or when reaching the root filesystem directory files are read top to bottom and the most recent pairs found take precedence thus in case a given file matches multiple sections within a single editorconfig file the pairs defined in the section that comes later in the editorconfig file take precedence over pairs defined in the section that comes earlier in the same editorconfig file if multiple editorconfig files have matching sections the pairs from the closer editorconfig file are read last so pairs in closer files take precedence capitalization of the file name as noted above the editorconfig filename should be lowercased on some platforms opening a file with a different capitalization results in opening the same file with lowercased file names on such a platform in addition to the all lowercased editorconfig file name a core may choose to also accept files with a different capitalization as if it were all lowercased informative such platform is common with a case insensitive filesystem for example a file named editorconfig exists in the filesystem but opening a file named editorconfig via a file opening api still opens the differently capitalized editorconfig file the behavior of the core as described in the previous paragraph is to prevent the need of the additional operation of specifically retrieving the filename which can be relatively expensive in the context of editorconfig supported pairs changed in version 0 17 1 editorconfig file sections contain key value pairs separated by an equal sign with the exception of the root key all pairs must be located under a section to take effect editorconfig cores shall accept and report all syntactically valid key value pairs even if the key is not defined in this specification editorconfig plugins shall ignore unrecognized keys and invalid unsupported values here is the list of all keys defined by this version of this specification and the supported values associated with them key supported values indent_style set to tab or space to use tabs or spaces for indentation respectively option tab implies that an indentation is to be filled by as many hard tabs as possible with the rest of the indentation filled by spaces a non normative explanation can be found in the indentation_ section the values are case insensitive indent_size set to a whole number defining the number of columns used for each indentation level and the width of soft tabs when supported if this equals tab the indent_size shall be set to the tab size which should be tab_width if specified else the tab size set by the editor the values are case insensitive tab_width set to a whole number defining the number of columns used to represent a tab character this defaults to the value of indent_size and should not usually need to be specified end_of_line set to lf cr or crlf to control how line breaks are represented the values are case insensitive charset set to latin1 utf 8 utf 8 bom utf 16be or utf 16le to control the character set use of utf 8 bom is discouraged the values are case insensitive spelling_language sets the natural language that should be used for spell checking only one language can be specified there is no default value the format is ss or ss tt where ss is an iso 639 two letter language code and tt is an iso 3166 two letter territory identifier therefore spelling_language must be either two or five characters long note this property does not specify the charset to be used the charset is in separate property charset trim_trailing_whitespace set to true to remove all whitespace characters preceding newline characters in the file and false to ensure it doesn t insert_final_newline set to true ensure file ends with a newline when saving and false to ensure it doesn t editors must not insert newlines in empty files when saving those files even if insert_final_newline true root must be specified in the preamble set to true to tell the core not to check any higher directory for editorconfig settings for on the current filename the value is case insensitive for any pair a value of unset removes the effect of that pair even if it has been set before for example add indent_size unset to undefine the indent_size pair and use editor defaults pair keys are case insensitive all keys are lowercased after parsing cores must accept keys and values with lengths up to and including 1024 and 4096 characters respectively beyond that each implementation may choose to define its own upper limits or no explicit upper limits at all indentation non normative the indentation related options indent_style indent_size and tab_width require a special documentation section to specify their behavior consider the following code snippet def execute source indentation is important for i in source split print i the indent_size setting for this code snippet equals 4 because indent_size means how many columns are required to indent the next line in relation to previous if indentation of course is applicable for this line then the next question is how this indentation of 4 columns is achieved it may be 4 consequent spaces soft tabs a single tab with width equal to 4 or two tabs with width equal to 2 this is when indent_style comes into picture it specifies what character should be used whenever possible in order to achieve the indentation size specified in indent_size to fully understand what whenever possible actually means let s consider the following editorconfig file living in the same directory as the file above root true example_file py indent_style tab indent_size 4 tab_width 3 the indent_size of 4 is not achievable by placing 1 or 2 consequent tabs because tab_width 3 therefore in order to comply with this editorconfig configuration the new lines where indentation is applicable must be precisely indented with one tab and one space that is because by placing one tab we re not achieving the indent_size required but by placing the 2 consequent tabs we re overreaching therefore although indent_style is tab we still have to supplement with one space character to fulfill the requirement for another example if we have the following editorconfig file root true another_file py indent_style tab indent_size 8 tab_width 4 one must expect that spaces will not be used at all for indentation since all the indentation can be achieved via tabs only additionally it is possible to have indent_size less than the tab_width root true another_file py indent_style tab indent_size 4 tab_width 8 to understand the way it works let s look at the following example def func if true return true in this case the line where the if statement condition is specified is indented with 4 spaces because the indent_size 4 and the tab cannot fit in on the other hand the line with return statement must be indented with one tab because the indentation level for this line is 8 columns and a tab can fit in suggestions for plugin developers todo for now please read the plugin guidelines on github wiki versioning this section applies beginning with version 0 14 0 of this specification this specification has a version tagged in the specification repository each specification version corresponds to the same version in the core tests repository the version numbering of the specification follows semantic versioning 2 0 0 semver the version numbering of the core tests repository also follows semver each editorconfig core to pass the core tests must process version numbers given with the b switch and must report version numbers when given v or version the version numbers used for b v and version are versions of this specification for example the vimscript core might respond to v with editorconfig vimscript core v1 0 0 specification version 0 14 0 cores plugins or editors supporting editorconfig have their own version numbers those version numbers are independent of the version number of this specification editorconfig specification navigation related topics documentation overview 2019 2024 editorconfig team powered by sphinx 8 2 3 alabaster 1 0 0 page source