alan-if / alan-docs

Alan IF Documentation Project
https://git.io/alan-docs
Other
3 stars 0 forks source link

Add EditorConfig to Enforce Code-Styles Consistency #72

Closed tajmone closed 3 years ago

tajmone commented 3 years ago

In order to pass the validation test, we also need to enforce EditorConfig setting in the /alan-xsl-fopub/ repository included in this repo as Git submodule:

Since the alan-xsl-fopub repository will define it's EditorConfig settings as root = true, the validation tool will use those setting inside the Git submodule directory.


Thanks to EditorConfig we'll be able to enforce consistent code styles in the repository, and all modern editors should pick up those settings and enforce them over the user default settings when working on this repo — either natively or by installing a third party EditorConfig plug-in.

@thoni56, for Emacs you'll find an EditorConfig plugin here:

Hopefully the adoption of EditorConfig will solve many of the current conflicts due to noise changes added to the code due to different settings for indentation, trailing spaces, etc. I've been using it a lot in my repos during the past year, and it has improved the working experience a lot.