wiki/contributing/formatting/editorconfig.md

title	description	published	date	tags	editor	dateCreated
Editorconfig	Using .editorconfig	true	2024-08-02T23:15:00.000Z		markdown	2024-05-05T18:30:37.455Z

Global

Start your .editorconfig file with this:

root = true

[*]
charset = utf-8
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true
indent_style = tabs

The formatting tool prettier adjust auto-formatting styles according to .editorconfig but ignores some attributes. This includes insert_final_newline which is hard-coded to true. See prettier issue #6360 Please ensure you are not setting insert_final_newline in any of your language specific settings. {.is-info}

And add any additional types you need from below, making sure to separate each section with a new line.

---

Programming Languages

Nix

Using nixfmt-rfc-style

[*.nix]
indent_size = 2
indent_style = space

Python

Using pycodestyle

[*.{py,py3}]
indent_size = 4
indent_style = space

Node.js

Using prettier

[*.{cjs,mjs,js,ts,jsx,tsx}]
indent_size = 2

Rust

Using cargo fmt

[*.rs,Cargo.toml]
indent_size = 4

Go

Using gofmt

[*.{go,mod}]
indent_size = 4

C and Related

[*.{c,cpp,cs,h,hpp,C,H,cxx,hxx}]
indent_size = 4

[*.{sln,csproj,vbproj,vcxproj.filters,proj,projitems,shproj}]
indent_size = 2

Shell Script

[*.{sh,zsh,bash,bat,cmd,ps1,psm1}]
indent_size = 4

Markup Languages

Markdown

[*.md]
indent_size = 2
trim_trailing_whitespace = false

Web

[*.{htm,html,less,svg,vue}]
indent_size = 2

[*.{css.sass,scss,less}]
indent_size = 2

Data Storage Files

JSON, YAML

[*.{json,json5,webmanifest}]
indent_size = 2

YAML

[*.{yaml,yml}]
indent_style = space
indent_size = 2

TOML

[*.toml]
indent_style = unset
indent_size = 0

*RC

[.*rc]
indent_size = 2

CSV

[*.csv]
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_size = 0
indent_style = unset

Lockfile

[*.lock]
indent_style = unset
insert_final_newline = unset

Git

[*.{diff,patch}]
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_size = unset
indent_style = unset

[.{gitignore,gitreview,gitmodules}]
indent_style = unset
indent_size = 0

Keys

[*.{asc,key,ovpn,pem}]
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset

Build Tool Files

Make

[Makefile]
indent_size = 2