]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Add EditorConfig file (#1930)
authorLouis Orleans <louis@orleans.io>
Tue, 31 Oct 2017 15:13:40 +0000 (08:13 -0700)
committerJack Humbert <jack.humb@gmail.com>
Tue, 31 Oct 2017 15:13:40 +0000 (11:13 -0400)
* ðŸ”§ add editorconfig

This makes supported editors automatically change their settings to match desired code styles

* ðŸ”§ add extension recommendation for VSCode

This will cause VS Code to prompt the user to install the EditorConfig extension when they open the project.

If this is felt to be too opinionated, I can revert it.

.editorconfig [new file with mode: 0644]
.vscode/extensions.json [new file with mode: 0644]

diff --git a/.editorconfig b/.editorconfig
new file mode 100644 (file)
index 0000000..82837f7
--- /dev/null
@@ -0,0 +1,18 @@
+# EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 4
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
new file mode 100644 (file)
index 0000000..0543f3d
--- /dev/null
@@ -0,0 +1,6 @@
+// Suggested extensions
+{
+  "recommendations": [
+    "EditorConfig.EditorConfig"
+  ]
+}