config: update .editorconfig parameters according to current format of files

[davorpa]

What does this PR do?

Improve repo

For resources

Description

Update .editorconfig parameters according to values provided by @SethFalco in #5564 (commit e9f7dff) and extend it.

• 2 spaces indent for yaml or yml files
• 2 spaces indent for json & jsonc (commented) files
• avoid strip trailing spaces in any kind of markdown files

Moreabout editorconfig syntax at: https://editorconfig.org/

Checklist:

• Read our contributing guidelines
• Search for duplicates.

Follow-up

• Check the status of GitHub Actions and resolve any reported warnings!

[LuigiImVector]

Why did you use ; for the rule comments and # for the file description? And why did you include the python, bat, powershell files if they are not used?

[davorpa]

Why did you use ; for the rule comments and # for the file description?

According documentation comments can be addressed by # or ; without side effects: https://editorconfig-specification.readthedocs.io/#file-format

So to differentiate, I've preferred to use ; for section/heading comments and # for general or header ones.

And why did you include the python, bat, powershell files if they are not used?

Sorry, I have some scripts in my local environment testing things with nodejs and remark. Let's decide if revert fd9a837, 5516f58, 20bac81, 4b2c37b commits is needed.

Its parametrization is taken from known examples provided in: https://github.com/editorconfig/editorconfig/wiki/Projects-Using-EditorConfig

Moreover... I update the link pointing to this repo in that wiki 😜

[LuigiImVector]

Sorry, I have some scripts in my local environment testing things with nodejs and remark. Let's decide if revert fd9a837, 5516f58, 20bac81, 4b2c37b commits is needed.

I think they need to be deleted to have a cleaner code, maybe wait for a review from someone more experienced

[SethFalco]

I just use the same EditorConfig file in all my projects, regardless of the contents of the repository. (This One)
I don't see the harm in including the extra, especially since when or if a batch file were to be added, said person probably wouldn't update the EditorConfig after. On the other hand, it does seem a bit cluttered tbh.

The above is an opinion, and nothing more.

---

However, I think most if not all the comments should be entirely removed. (EditorConfig is very self-explanatory as it is.)

; JSON files - compress a little more
[*.{json,jsonc}]
indent_size = 2

And the comments aren't necessarily accurate either. "Compress" compared to what?
Coding conventions shouldn't be commented with an action, since that action may not apply to how everyone writes JSON.

In other words, the EditorConfig describes how the code should look to editors.
In this case, if it compresses or inflates the JSON file depends entirely on if the developer normally does 1 space, or 4 spaces.

[SethFalco]

I do also wonder where all the file extensions came from, for example Markdown.

; Markdown files - preserve whitespaces
[*.{md,mkd,mkdn,mdwn,mdown,markdown}]
trim_trailing_whitespace = false

On Wikipedia:

.md, .markdown

— https://en.wikipedia.org/wiki/Markdown

This is also another case where the comment seems a bit redundant. ^-^'
It only has 1 rule, which is to not trim trailing whitespace. We can tell it's for preserving the whitespace.

Edit: Just realized the file extensions were linked, fair enough. Does still seem cluttered to have them all through in the repository. Just *.md would be enough. (Since in we'd probably end up enforcing the use of that file extension anyway.)

[davorpa]

Thanks for the starter template. Adopted a bit.

Comments are in part for my future self (I have a fish memory sometimes)

Better now after 520d0e9 or completely remove not used?

[LuigiImVector]

Better now after 520d0e9 or completely remove not used?

Comments are better now even if i think you can remove the unused ones

[davorpa]

What more I need to go ahead with the PR?

[LuigiImVector]

What more I need to go ahead with the PR?

I think the only problems are the "excess" of information it contains: comments and (not yet) used extensions.

Comments can be left as they are in my opinion, for the extensions (ps1, js, ts...) I find that they are currently useless but could be used in the future, if no one opposes PR can be merged.

[davorpa]

I clean it a bit more.

[LuigiImVector]

LGTM