4 ms·

No, but ignoring these basic project conventions can lead to issues when another developer tries to work with the file, specifically around charset and line end

No, but ignoring these basic project conventions can lead to issues when another developer tries to work with the file, specifically around charset and line endings.

beaker52 11y ago
editorconfig only defines the following properties: charset indent_style indent_size tab_width end_of_line trim_trailing_whitespace insert_final_newline These are all sensible things to enforce (with the exception of tab_width, which is actually a display preference). Subjectively, other things are mostly flexible.
- Maken 11y ago
  There are more properties listed in the complete list (link is above the short list), mostly about parenthesis and braces. I guess they aren't listed in the main page because they are language-specific.
teamhappy 11y ago
But editors can infer these settings anyway.
- beaker52 11y ago
  Partially. Some editors can infer things like indentation and new lines by looking at the existing file, yes. Crucially, what about new files? For charset, this needs to be defined since charsets share byte encodings: http://www.fileformat.info/info/charset/UTF-8/list.htm http://www.fileformat.info/info/charset/UTF-8/list.htm http://www.fileformat.info/info/charset/US-ASCII/list.htm http://www.fileformat.info/info/charset/US-ASCII/list.htm Same goes for new line at the end of the file, how do you know ALL files of this type are meant to end with a new line or not? Inference doesn't completely solve the problem that editorconfig solves. That said, if you don't want editorconfig then don't use it. If you're working on a project that uses editorconfig, feel free to ignore it - as long as you adhere to the code style of that project. editorconfig is simply a tool to help you adhere to a project code guidelines.
  - teamhappy 11y ago
    > Crucially, what about new files? vim-sleuth handles this one by looking at similar files in the same directory (or the rest of the tree, if it doesn't find any.) > For charset, [...] Almost all code bases use UTF-8 without BOM, which also happens to be the default encoding in most editors. > Same goes for new line at the end of the file, > how do you know ALL files of this type are meant > to end with a new line [...] ? POSIX wants the newline. I get your point though. I used to use editorconfig myself, but it didn't really do anything for me. IMHO linters/formatters do a much better job.
    - beaker52 11y ago
      That's cool, but that's one plugin for one editor - editorconfig is a simple plugin with a very wide range of support to solve the problem it solves. Linters and formatters are great for enforcing code styles but they tend to be per language and require more configuration, shy of ripping off an existing spec. If you don't want to go the whole hog and only need some basic constraints then editorconfig is easy to throw into a repo root.
    - 1wd 11y ago
      Notepad++ defaults to Ansi (although it can be changed). Visual Studio defaults to UTF-8 with BOM. (And I don't think you can change that easily.)
      - deathanatos 11y ago
        "ANSI" hardly counts as a default. (ANSI is MS's incorrect term to mean the system's encoding, which can be any of a number of different character sets.)

No, but ignoring these basic project conventions can lead to issues when another developer tries to work with the file, specifically around charset and line endings.

beaker52 11y ago

editorconfig only defines the following properties: charset indent_style indent_size tab_width end_of_line trim_trailing_whitespace insert_final_newline These are all sensible things to enforce (with the exception of tab_width, which is actually a display preference). Subjectively, other things are mostly flexible.

Maken 11y ago
There are more properties listed in the complete list (link is above the short list), mostly about parenthesis and braces. I guess they aren't listed in the main page because they are language-specific.

teamhappy 11y ago

But editors can infer these settings anyway.

beaker52 11y ago
Partially. Some editors can infer things like indentation and new lines by looking at the existing file, yes. Crucially, what about new files? For charset, this needs to be defined since charsets share byte encodings: http://www.fileformat.info/info/charset/UTF-8/list.htm http://www.fileformat.info/info/charset/UTF-8/list.htm http://www.fileformat.info/info/charset/US-ASCII/list.htm http://www.fileformat.info/info/charset/US-ASCII/list.htm Same goes for new line at the end of the file, how do you know ALL files of this type are meant to end with a new line or not? Inference doesn't completely solve the problem that editorconfig solves. That said, if you don't want editorconfig then don't use it. If you're working on a project that uses editorconfig, feel free to ignore it - as long as you adhere to the code style of that project. editorconfig is simply a tool to help you adhere to a project code guidelines.
- teamhappy 11y ago
  > Crucially, what about new files? vim-sleuth handles this one by looking at similar files in the same directory (or the rest of the tree, if it doesn't find any.) > For charset, [...] Almost all code bases use UTF-8 without BOM, which also happens to be the default encoding in most editors. > Same goes for new line at the end of the file, > how do you know ALL files of this type are meant > to end with a new line [...] ? POSIX wants the newline. I get your point though. I used to use editorconfig myself, but it didn't really do anything for me. IMHO linters/formatters do a much better job.
  - beaker52 11y ago
    That's cool, but that's one plugin for one editor - editorconfig is a simple plugin with a very wide range of support to solve the problem it solves. Linters and formatters are great for enforcing code styles but they tend to be per language and require more configuration, shy of ripping off an existing spec. If you don't want to go the whole hog and only need some basic constraints then editorconfig is easy to throw into a repo root.
  - 1wd 11y ago
    Notepad++ defaults to Ansi (although it can be changed). Visual Studio defaults to UTF-8 with BOM. (And I don't think you can change that easily.)
    - deathanatos 11y ago
      "ANSI" hardly counts as a default. (ANSI is MS's incorrect term to mean the system's encoding, which can be any of a number of different character sets.)