Support editorconfig

[Freed-Wu]

Fix #1843, Fix #2128, Fix #2118

EditorConfig cores shall accept and report all syntactically valid key-value pairs, even if the key is not defined in this specification.
EditorConfig plugins shall ignore unrecognized keys and invalid/unsupported values.

So we can use .editorconfig or global ~/.config/editorconfig.ini :

[{build,*.subpackage}.sh]
shellcheck.disable=SC2034

[{*.ebuild,*.eclass,*.conf,color.map,.devscripts,*.mdd}]
shellcheck.shell=bash
shellcheck.disable=SC2034

[{PKGBUILD,*.install}]
shellcheck.shell=bash
shellcheck.disable=SC2034,SC2154

[APKBUILD]
shellcheck.shell=sh
shellcheck.disable=SC2034,SC2154

[*/bash-completion/completions/*]
shellcheck.shell=bash

Refer termux-language-server for filenames.

Final result:

PS: If someone want to realize #1844 #356 , can extend the config:

[{PKGBUILD,*.install}]
shellcheck.shell=bash
shellcheck.sourcefile=/the/path/of/PKGBUILD.d.sh

PKGBUILD.d.sh:

# avoid SC2154
export pkgdir srcdir
# avoid SC2034
export pkgver # ...

haskell doesn't have library for editorconfig. and ini doesn't support disabling inline comment as editorconfig. So we have to create one.

[Freed-Wu]

it is interpreted in the same way as .shellcheckrc

So should we provide a different error message?

[e-kwsm]

So should we provide a different error message?

As of 9aa7871, shellcheck emits

In /tmp/.editorconfig line 4:
shellcheck.disable = SC2148 #abc
       ^-- SC1134 (error): Failed to process /tmp/.editorconfig, line 4: Expected '=' after directive key. Fix any mentioned problems and try again.

which is clear.

[e-kwsm]

Thank you for your contribution!