diff mbox series

[v2] editorconfig: set emacs mode

Message ID 20180821103839.19355-1-marcandre.lureau@redhat.com (mailing list archive)
State New, archived
Headers show
Series [v2] editorconfig: set emacs mode | expand

Commit Message

Marc-André Lureau Aug. 21, 2018, 10:38 a.m. UTC
Some time ago, I proposed to use an (eval) in .dir-locals.el to set
the mode for all json files and Makefile. Unfortunately, this isn't
safe, and emacs will prompt the user, which isn't very friendly.

Fortunately, editorconfig provides a special config key which does
allow to set the emacs mode. Add a few missing entries and set the
emacs mode.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 .editorconfig | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Markus Armbruster Aug. 24, 2018, 7:38 a.m. UTC | #1
Marc-André Lureau <marcandre.lureau@redhat.com> writes:

> Some time ago, I proposed to use an (eval) in .dir-locals.el to set
> the mode for all json files and Makefile. Unfortunately, this isn't
> safe, and emacs will prompt the user, which isn't very friendly.
>
> Fortunately, editorconfig provides a special config key which does
> allow to set the emacs mode. Add a few missing entries and set the
> emacs mode.

Please mention editorconfig requires a plugin to work.  Without that,
the reader is left to wonder why we keep the "redundant" Emacs file
local variables.

>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>  .editorconfig | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
>
> diff --git a/.editorconfig b/.editorconfig
> index b2022e391a..683c543be3 100644
> --- a/.editorconfig
> +++ b/.editorconfig
> @@ -6,10 +6,23 @@ end_of_line = lf
>  insert_final_newline = true
>  charset = utf-8
>  
> +[*.mak]
> +indent_style = tab
> +indent_size = 8
> +file_type_emacs = makefile
> +

Aside: we should name these .mk like a sane person.

>  [Makefile*]
>  indent_style = tab
>  indent_size = 8
> +file_type_emacs = makefile
>  
>  [*.{c,h}]
>  indent_style = space
>  indent_size = 4
> +
> +[*.{vert,frag}]
> +file_type_emacs = glsl
> +
> +[*.json]
> +indent_style = space
> +file_type_emacs = python

With the commit message improved:
Acked-by: Markus Armbruster <armbru@redhat.com>
Eric Blake Aug. 24, 2018, 4:13 p.m. UTC | #2
On 08/24/2018 02:38 AM, Markus Armbruster wrote:
> Marc-André Lureau <marcandre.lureau@redhat.com> writes:
> 
>> Some time ago, I proposed to use an (eval) in .dir-locals.el to set
>> the mode for all json files and Makefile. Unfortunately, this isn't
>> safe, and emacs will prompt the user, which isn't very friendly.
>>
>> Fortunately, editorconfig provides a special config key which does
>> allow to set the emacs mode. Add a few missing entries and set the
>> emacs mode.
> 
> Please mention editorconfig requires a plugin to work.  Without that,
> the reader is left to wonder why we keep the "redundant" Emacs file
> local variables.

Is it also worth a (separate) patch to .editorconfig to add a comment 
up-front about needing plugins for some editors? Right now, it just has 
the single comment:

# http://editorconfig.org

which, if followed, will get you to the same information, but I'm a fan 
of not having to chase a URL when it is just as easy to provide a short 
summary in place.
diff mbox series

Patch

diff --git a/.editorconfig b/.editorconfig
index b2022e391a..683c543be3 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -6,10 +6,23 @@  end_of_line = lf
 insert_final_newline = true
 charset = utf-8
 
+[*.mak]
+indent_style = tab
+indent_size = 8
+file_type_emacs = makefile
+
 [Makefile*]
 indent_style = tab
 indent_size = 8
+file_type_emacs = makefile
 
 [*.{c,h}]
 indent_style = space
 indent_size = 4
+
+[*.{vert,frag}]
+file_type_emacs = glsl
+
+[*.json]
+indent_style = space
+file_type_emacs = python