Skip to content

Commit a69041e

Browse files
committed
Add EditorConfig to set some common style rules
1 parent a437fad commit a69041e

File tree

2 files changed

+152
-1
lines changed

2 files changed

+152
-1
lines changed

.editorconfig

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# EditorConfig: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Default preferences
7+
[*]
8+
end_of_line = lf
9+
insert_final_newline = true
10+
11+
# IDEA specific
12+
curly_bracket_next_line = false
13+
wildcard_import_limit = 0
14+
15+
16+
# Generic XML
17+
# https://google.github.io/styleguide/xmlstyle.html
18+
[*.xml]
19+
indent_size = 2
20+
indent_style = space
21+
22+
# Maven
23+
# https://maven.apache.org/
24+
[pom.xml]
25+
indent_size = 4
26+
indent_style = space
27+
28+
# Groovy (gradle)
29+
# ?
30+
[*.{groovy, gradle}]
31+
indent_size = 4
32+
indent_style = space
33+
34+
# Bazel: https://bazel.build/
35+
# https://github.com/bazelbuild/buildtools/blob/master/BUILD.bazel
36+
[*.{bazel, bzl}]
37+
indent_size = 4
38+
indent_style = space
39+
40+
# CSS
41+
# https://google.github.io/styleguide/htmlcssguide.xml#General_Formatting_Rules
42+
# http://cssguidelin.es/#syntax-and-formatting
43+
[*.css]
44+
indent_size = 2
45+
indent_style = space
46+
trim_trailing_whitespace = true
47+
48+
# GNU make
49+
# https://www.gnu.org/software/make/manual/html_node/Recipe-Syntax.html
50+
[Makefile]
51+
indent_style = tab
52+
53+
# Go
54+
# https://golang.org/cmd/gofmt/
55+
[{go.mod, *.go}]
56+
indent_style = tab
57+
58+
# GraphQL
59+
# https://graphql.org/learn/
60+
# https://prettier.io
61+
[*.graphql]
62+
indent_size = 2
63+
indent_style = space
64+
65+
# HTML
66+
# https://google.github.io/styleguide/htmlcssguide.xml#General_Formatting_Rules
67+
[*.{htm, html}]
68+
indent_size = 2
69+
indent_style = space
70+
trim_trailing_whitespace = true
71+
72+
# Java
73+
# https://google.github.io/styleguide/javaguide.html#s4.2-block-indentation
74+
[*.java]
75+
indent_size = 2
76+
indent_style = space
77+
78+
# JavaScript, JSON, JSX, JavaScript Modules, TypeScript
79+
# https://github.com/feross/standard
80+
# https://prettier.io
81+
# https://github.com/angular/angular-cli/blob/master/.editorconfig
82+
[*.{cjs, js, json, jsx, mjs, ts, tsx}]
83+
indent_size = 2
84+
indent_style = space
85+
trim_trailing_whitespace = true
86+
quote_type = single
87+
88+
89+
# Kotlin (and gradle.kts)
90+
# https://android.github.io/kotlin-guides/style.html#indentation
91+
[*.{kt, kts}]
92+
indent_size = 4
93+
indent_style = space
94+
95+
# LESS
96+
# https://github.com/less/less-docs#less-standards
97+
[*.less]
98+
indent_size = 2
99+
indent_style = space
100+
101+
# PHP
102+
# http://www.php-fig.org/psr/psr-2/
103+
[*.php]
104+
indent_size = 4
105+
indent_style = space
106+
107+
# Python
108+
# https://www.python.org/dev/peps/pep-0008/#code-lay-out
109+
[*.py]
110+
indent_size = 4
111+
indent_style = space
112+
113+
# Ruby
114+
# http://www.caliban.org/ruby/rubyguide.shtml#indentation
115+
[*.rb]
116+
indent_size = 2
117+
indent_style = space
118+
119+
# Rust
120+
# https://github.com/rust-lang/rust/blob/master/src/doc/style/style/whitespace.md
121+
[*.rs]
122+
indent_size = 4
123+
indent_style = space
124+
insert_final_newline = false
125+
trim_trailing_whitespace = true
126+
127+
# SASS
128+
# https://sass-guidelin.es/#syntax--formatting
129+
[*.{sass, scss}]
130+
indent_size = 2
131+
indent_style = space
132+
133+
# Shell
134+
# https://google.github.io/styleguide/shell.xml#Indentation
135+
[*.{bash, sh, zsh}]
136+
indent_size = 2
137+
indent_style = space
138+
139+
# TOML
140+
# https://github.com/toml-lang/toml/tree/master/examples
141+
[*.toml]
142+
indent_size = 2
143+
indent_style = space
144+
145+
# YAML
146+
# http://yaml.org/spec/1.2/2009-07-21/spec.html#id2576668
147+
[*.{yaml, yml}]
148+
indent_size = 2
149+
indent_style = space

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Contributing
2-
When contributing to this repository, please first discuss the change you wish to make via issue.
2+
When contributing to this repository, please first discuss the change you wish to make via an issue.
3+
4+
This project uses [EditorConfig](https://editorconfig.org) to set some style rules. If your IDE does not support it natively, please install [a plugin](https://editorconfig.org/#download).
35

46
## Learning
57
Developer documentation may be found under `docs/dev/`.

0 commit comments

Comments
 (0)