Add editorconfig and update bash files accordingly

[b10n1k]

https://progress.opensuse.org/issues/153793
Pull latest changes of .editorconfig from os-autoinst-common, shfmt to the
dependencies and enable CI checks.

recreate #5440

[okurz]

@Martchus why are javascript issues still showing up like that?

And
https://app.circleci.com/pipelines/github/os-autoinst/openQA/12852/workflows/e01e4366-9228-4b2b-829a-825f2c36f18a/jobs/119783

says
"dependencies.yaml
189:3 error duplication of key "shfmt" in mapping (key-duplicates)"

[baierjan]

Suggested change

	shfmt-3.5.1
	setxkbmap-1.3.1
	ShellCheck-0.8.0
	shfmt-3.5.1
	setxkbmap-1.3.1
	ShellCheck-0.8.0
	shfmt-3.5.1

[b10n1k]

have been fixed

[b10n1k]

eslint starts failing once the .editorconfig is created.
The "prettier/prettier": "error" in .eslintrc.json is causing the errors

[okurz]

eslint starts failing once the .editorconfig is created. The "prettier/prettier": "error" in .eslintrc.json is causing the errors

Ok, so as we don't have plans to merge PRs with failing checks what are your intentions about it?

[perlpunk]

I just stumbled upon this issue: mvdan/sh#664
And it mentions [[shell]]. I can't find that in the shfmt documentation nor in the EditorConfig documentation but it seems to work :)

The problem seems to be that eslint is using the editorconfig as well, and as we are using * we can't blame it :)

[perlpunk]

Oh, nevermind, I misread the diff.
It was apparently touching the right files when i used [[shell]], but then it was using the default formatting rules, using tabs etc.

[perlpunk]

I tried [script/**] instead, but it still touched files elsewhere (and did not touch anything under script). Weird. Have to work on other tasks now though...

[perlpunk]

Apparently this works, but we can't use the config file then:

shfmt -w -i 4 -bn -ci -sr $(shfmt -f .)

e.g.

shfmt -w $(shfmt -f .)

does not use .editorconfig

So -f is able to find the right files.

[baierjan]

What about the other way around?

[*.js]
ignore = true

[perlpunk]

I suggest to do the following right now:

Suggested change

	shfmt -d .
	shfmt -d -i 4 -bn -ci -sr $(shfmt -f .)

and remove the .editorconfig symlink.
We can think of any improvements later and get this big PR merged.

[Martchus]

Considering we were not able to make eslint/prettier ignore the editor config (after reading https://github.com/prettier/eslint-plugin-prettier, https://prettier.io/docs/en/configuration.html, https://prettier.io/docs/en/options.html and https://eslint.org/docs/latest/use/configure/configuration-files#using-configuration-files and trying several variants) that might be the best way to move this forward for now, indeed.

[perlpunk]

And apparently

shfmt -d -i 4 -bn -ci -sr .

also works. Not sure why we ruled that out when we experimented with it in the scripts repo.

[perlpunk]

oh right, because of the .bpan directory which we wanted to ignore.
So we might need something like this, depending on the repo:

shfmt -d -i 4 -bn -ci -sr  $(shfmt -f . | grep -v '^.bpan' )

[perlpunk]

I think this doesn't work as it is a Makefile, where shell syntax doesn't work.
Also we don't have .bpan here in this repo, so maybe don't use it.
Also the -d option is duplicate.
Try this:

Suggested change

	shfmt -d -d -i 4 -bn -ci -sr $(shfmt -f . | grep -v '^.bpan' )
	shfmt -d -i 4 -bn -ci -sr $$(shfmt -f .)

With the double dollar it should work.

[Martchus]

Looks like it ran successfully:

lib/OpenQA/Worker/Isotovideo/Client.pm source OK
lib/perlcritic/Perl/Critic/Policy/HashKeyQuotes.pm source OK
shfmt -d -i 4 -bn -ci -sr $(shfmt -f .)
make test-unit-and-integration TIMEOUT_M=20 PROVE_ARGS="$HARNESS t/*{tidy,compile}*.t" GLOBIGNORE="t/25-cache-service.t:t/43-scheduling-and-worker-scalability.t:t/ui/01-list.t:t/ui/26-jobs_restart.t:t/ui/13-admin.t:"
make[1]: Entering directory '/home/squamata/project'

And the JavaScript check didn't complain anymore as well.