Since this builds on #2000, it does not need to incorporate the same changes again. When #2000 is merged, this PR will possibly have unnecessary merge conflicts. Please remove the changes that are already present in #2000.

Not sure about #1980, but it seems to have these very changes too if I‘m not mistaken.

Follow up comment to my earlier review comment. Below shows my preferred approach with using docker images for linting, but they need to be further adapted into lint.sh and verified as working the same.

I have slightly improved/modified EC config below, and enabled --check-sources for shellcheck config (which raises a single SC2153 warning that wasn't picked up). I also believe I resolved the readlink -f issue that was being had on macOS, I am not entirely sure why the more complicated workaround was in place, the option for --source-path has been available for about 2 years or so. @aendeavor added it in Oct 2020 for --external-sources, perhaps was just missing the --source-path=SCRIPTDIR config addition?

Rough shell commands to run each official docker image with config like in lint.sh. If they're successful with no issues, they'll be blank in output when exiting (should function just like error handling for existing command usage). Each one seemed to run fine and as expected, although I've only run them individually manually, no lint.sh.

HADOLINT_VERSION=2.4.1
EC_VERSION=2.3.5
SC_VERSION=0.7.2

docker run --rm --tty \
  --volume "${PWD}:/ci:ro" \
  --workdir "/ci" \
  "hadolint/hadolint${HADOLINT_VERSION}-alpine" hadolint --config "test/linting/.hadolint.yaml" Dockerfile

docker run --rm --tty \
  --volume "${PWD}:/ci:ro" \
  --workdir "/ci" \
  "mstruebing/editorconfig-checker:${EC_VERSION}" ec -config "test/linting/.ecrc.json"

# File paths for shellcheck:
local F_SH="$(find . -type f -iname '*.sh' \
  -not -path './test/bats/*' \
  -not -path './test/test_helper/*' \
  -not -path './target/docker-configomat/*' \
)"
local F_BIN="$(find 'target/bin' -type f -executable)"
local F_BATS="$(find 'test/' -maxdepth 1 -type f -iname '*.bats')"

# This command is a bit easier to grok as multi-line. There is a `.shellcheckrc` file, but it's only supports half of the options below, thus kept as CLI:
local CMD_SHELLCHECK=(
  shellcheck --external-sources --check-sources
  --severity=style
  --color=auto
  --wiki-link-count=50
  --enable=all
  --exclude=SC2154
  --source-path=SCRIPTDIR
  "${F_SH} ${F_BIN} ${F_BATS}"
)

docker run --rm --tty \
  --volume "${PWD}:/ci:ro" \
  --workdir "/ci" \
  "koalaman/shellcheck-alpine:v${SC_VERSION}" ${CMD_SHELLCHECK[@]}

test/linting/.ecrc.json: (modified to remove version as it's no longer required and the docker image was not compiled with it correctly, also moves the exclude config into the actual config file)

{
  "Verbose": false,
  "Debug": false,
  "IgnoreDefaults": false,
  "SpacesAftertabs": true,
  "NoColor": false,
  "Exclude": [
    "^test/",
    "\\.git.*",
    "\\.bats$",
    "\\.cf$",
    "\\.conf$",
    "\\.init$",
    "\\.md$"
  ],
  "AllowedContentTypes": [],
  "PassedFiles": [],
  "Disable": {
    "EndOfLine": false,
    "Indentation": false,
    "InsertFinalNewline": false,
    "TrimTrailingWhitespace": false,
    "IndentSize": false,
    "MaxLineLength": false
  }
}

Documentation preview for this PR is ready! 🎉

Built with commit: 7707464

@aendeavor is the trap line with ERR at the end still valid?

@aendeavor is the trap line with ERR at the end still valid?

Yes :) In case of an unexpected error, it will print information via the __log_err function. This can help debugging or with issue reports. I'd leave it in there.

Yes :) In case of an unexpected error, it will print information via the __log_err function. This can help debugging or with issue reports. I'd leave it in there.

@aendeavor I meant the ERR variable part as it no longer exists anywhere else in the file?

Yes :) In case of an unexpected error, it will print information via the __log_err function. This can help debugging or with issue reports. I'd leave it in there.

@aendeavor I meant the ERR variable part as it no longer exists anywhere else in the file?

I understand. Then this may not be needed anymore and can be removed entirely I guess.