From feea1b444e8dabddc10f380ff61ef97f4ff6fa62 Mon Sep 17 00:00:00 2001 From: Luca Saccarola Date: Mon, 11 Nov 2024 21:33:50 +0100 Subject: [PATCH] Add an .editorconfig file to repository This commit tries to use an editorconfig file to ensure the same settings across editors while contributing to the vim repository. The rules are based of the guidelines defined in `runtime/doc/develop.txt`. Signed-off-by: Luca Saccarola Signed-off-by: Christian Brabandt --- .editorconfig | 21 +++++++++++++++++++++ Filelist | 1 + runtime/doc/develop.txt | 6 +++++- 3 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..bda9fd2896 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +# https://spec.editorconfig.org/#supported-pairs +root = true + +[*] +indent_style = tab +tab_width = 8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.{c,h,proto}] +indent_size = 4 + +[*.{md,yml,sh,bat}] +# This will become the default after we migrate the codebase +indent_style = space +indent_size = 2 + +[*.md] +# Markdown uses trailing whitespaces to do an hard line break +# https://spec.commonmark.org/0.31.2/#hard-line-breaks +trim_trailing_whitespace = false diff --git a/Filelist b/Filelist index 96af57b439..1f899b5c77 100644 --- a/Filelist +++ b/Filelist @@ -18,6 +18,7 @@ SRC_ALL = \ .hgignore \ .appveyor.yml \ .codecov.yml \ + .editorconfig \ ci/appveyor.bat \ ci/config.mk*.sed \ ci/if_ver*.vim \ diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index dd8b94d91b..84aa53dc8c 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -1,4 +1,4 @@ -*develop.txt* For Vim version 9.1. Last change: 2024 Oct 31 +*develop.txt* For Vim version 9.1. Last change: 2024 Nov 11 VIM REFERENCE MANUAL by Bram Moolenaar @@ -166,6 +166,10 @@ stick to these rules, to keep the sources readable and maintainable. This list is not complete. Look in the source code for more examples. +The code repository contains an editorconfig file, that can be used together +with the distributed editorconfig plugin |editorconfig-install| to ensure the +recommended style is followed. + MAKING CHANGES *style-changes*