Skip to content

Commit 1c5f6fc

Browse files
StaticRocketpraneethbajjuri
authored andcommitted
feat: use editorconfig to enforce formatting
Why recommend formatting in the readme when it can be enforced using a common editor config that's already supported and loaded by vim/nvim and other editors by default [1]? Set some sane properties [2]. [1] https://editorconfig.org/#pre-installed [2] https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties Signed-off-by: Randolph Sapp <[email protected]>
1 parent 9b7cfac commit 1c5f6fc

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-7
lines changed

.editorconfig

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Shared editor configuration <https://editorconfig.org>
2+
3+
root = true
4+
5+
[*]
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
9+
[*.rst]
10+
indent_size = 3
11+
indent_style = space
12+
13+
[*.sh]
14+
indent_size = 8
15+
indent_style = tab
16+
17+
[*.py]
18+
indent_size = 4
19+
indent_style = space
20+
21+
[Dockerfile]
22+
indent_size = 8
23+
indent_style = tab

README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,3 @@ You can access the latest bleeding-edge documentation at the following link:
7979
- [Processor SDK Documentation](https://texasinstruments.github.io/processor-sdk-doc/)
8080

8181
Please treat GitHub Pages as the most up-to-date source of documentation.
82-
83-
## Tips and Tricks
84-
85-
Add the following to your `init.vim` to automatically use the standard
86-
whitespace values for RST files:
87-
88-
autocmd FileType rst set tabstop=3 shiftwidth=3 expandtab

0 commit comments

Comments
 (0)