Re: [PR PATCH] [Updated] lint templates with shellcheck

[classabbyamp <classabbyamp@users.noreply.github.com>]

[-- Attachment #1: Type: text/plain, Size: 4250 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages xshellcheck
https://github.com/void-linux/void-packages/pull/43949

lint templates with shellcheck
<!-- Uncomment relevant sections and delete options which are not applicable -->

#### Testing the changes
- I tested the changes in this PR: **YES**

we may want to disable some warnings by default, currently these warnings are raised:

| count | code   | wiki link                              |
|------:|:-------|:---------------------------------------|
|  8516 | SC2086 | https://www.shellcheck.net/wiki/SC2086 |
|   499 | SC2034 | https://www.shellcheck.net/wiki/SC2034 |
|   287 | SC2016 | https://www.shellcheck.net/wiki/SC2016 |
|   156 | SC2091 | https://www.shellcheck.net/wiki/SC2091 |
|   144 | SC2046 | https://www.shellcheck.net/wiki/SC2046 |
|   103 | SC2035 | https://www.shellcheck.net/wiki/SC2035 |
|    83 | SC2154 | https://www.shellcheck.net/wiki/SC2154 |
|    75 | SC2209 | https://www.shellcheck.net/wiki/SC2209 |
|    73 | SC2231 | https://www.shellcheck.net/wiki/SC2231 |
|    59 | SC2155 | https://www.shellcheck.net/wiki/SC2155 |
|    53 | SC2044 | https://www.shellcheck.net/wiki/SC2044 |
|    39 | SC2295 | https://www.shellcheck.net/wiki/SC2295 |
|    36 | SC2115 | https://www.shellcheck.net/wiki/SC2115 |
|    28 | SC2166 | https://www.shellcheck.net/wiki/SC2166 |
|    22 | SC2185 | https://www.shellcheck.net/wiki/SC2185 |
|    21 | SC2103 | https://www.shellcheck.net/wiki/SC2103 |
|    19 | SC1091 | https://www.shellcheck.net/wiki/SC1091 |
|    13 | SC2043 | https://www.shellcheck.net/wiki/SC2043 |
|    12 | SC2162 | https://www.shellcheck.net/wiki/SC2162 |
|    12 | SC2001 | https://www.shellcheck.net/wiki/SC2001 |
|    10 | SC2129 | https://www.shellcheck.net/wiki/SC2129 |
|     9 | SC2098 | https://www.shellcheck.net/wiki/SC2098 |
|     9 | SC2038 | https://www.shellcheck.net/wiki/SC2038 |
|     7 | SC2031 | https://www.shellcheck.net/wiki/SC2031 |
|     6 | SC2090 | https://www.shellcheck.net/wiki/SC2090 |
|     6 | SC2013 | https://www.shellcheck.net/wiki/SC2013 |
|     5 | SC2140 | https://www.shellcheck.net/wiki/SC2140 |
|     5 | SC2097 | https://www.shellcheck.net/wiki/SC2097 |
|     5 | SC2045 | https://www.shellcheck.net/wiki/SC2045 |
|     4 | SC2261 | https://www.shellcheck.net/wiki/SC2261 |
|     4 | SC2153 | https://www.shellcheck.net/wiki/SC2153 |
|     4 | SC2015 | https://www.shellcheck.net/wiki/SC2015 |
|     3 | SC2269 | https://www.shellcheck.net/wiki/SC2269 |
|     3 | SC2223 | https://www.shellcheck.net/wiki/SC2223 |
|     3 | SC2196 | https://www.shellcheck.net/wiki/SC2196 |
|     3 | SC2089 | https://www.shellcheck.net/wiki/SC2089 |
|     3 | SC2061 | https://www.shellcheck.net/wiki/SC2061 |
|     3 | SC2059 | https://www.shellcheck.net/wiki/SC2059 |
|     3 | SC2030 | https://www.shellcheck.net/wiki/SC2030 |
|     3 | SC2004 | https://www.shellcheck.net/wiki/SC2004 |
|     3 | SC2002 | https://www.shellcheck.net/wiki/SC2002 |
|     2 | SC2237 | https://www.shellcheck.net/wiki/SC2237 |
|     2 | SC2125 | https://www.shellcheck.net/wiki/SC2125 |
|     2 | SC2094 | https://www.shellcheck.net/wiki/SC2094 |
|     2 | SC2005 | https://www.shellcheck.net/wiki/SC2005 |
|     1 | SC2222 | https://www.shellcheck.net/wiki/SC2222 |
|     1 | SC2221 | https://www.shellcheck.net/wiki/SC2221 |
|     1 | SC2207 | https://www.shellcheck.net/wiki/SC2207 |
|     1 | SC2168 | https://www.shellcheck.net/wiki/SC2168 |
|     1 | SC2145 | https://www.shellcheck.net/wiki/SC2145 |
|     1 | SC2144 | https://www.shellcheck.net/wiki/SC2144 |
|     1 | SC2102 | https://www.shellcheck.net/wiki/SC2102 |
|     1 | SC2100 | https://www.shellcheck.net/wiki/SC2100 |
|     1 | SC2078 | https://www.shellcheck.net/wiki/SC2078 |
|     1 | SC2068 | https://www.shellcheck.net/wiki/SC2068 |
|     1 | SC2012 | https://www.shellcheck.net/wiki/SC2012 |
|     1 | SC2010 | https://www.shellcheck.net/wiki/SC2010 |
|     1 | SC1090 | https://www.shellcheck.net/wiki/SC1090 |

[ci skip]

A patch file from https://github.com/void-linux/void-packages/pull/43949.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-xshellcheck-43949.patch --]
[-- Type: text/x-diff, Size: 11947 bytes --]

From 29b8c75abc5c5ad21f4b1f2b0e8fb5853ba637d3 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 19 May 2023 15:28:53 -0400
Subject: [PATCH 1/6] common/scripts/template_shellcheck_shim: create shim for
 xshellcheck

---
 common/scripts/template_shellcheck_shim | 398 ++++++++++++++++++++++++
 1 file changed, 398 insertions(+)
 create mode 100644 common/scripts/template_shellcheck_shim

diff --git a/common/scripts/template_shellcheck_shim b/common/scripts/template_shellcheck_shim
new file mode 100644
index 0000000000000..48932d19dbcaf
--- /dev/null
+++ b/common/scripts/template_shellcheck_shim
@@ -0,0 +1,398 @@
+#!/bin/bash
+# this file is for use by xshellcheck from xtools
+#
+# by assigning and using every variable templates should contain,
+# it suppresses SC2034 (unused variable) and SC2154 (possibly unassigned
+# variable). set -e suppresses errors like SC2164 (use cd ... || exit).
+
+set -e
+
+# TODO: do other variables need handling?
+# _*
+# *_descr
+# *_groups
+# *_homedir
+# *_pgroup
+# *_shell
+# desc_option_*
+# build_option_*
+
+# global variables
+CHROOT_READY=
+CROSS_BUILD=
+DESTDIR=
+FILESDIR=
+PKGDESTDIR=
+XBPS_BUILDDIR=
+XBPS_BUILD_ENVIRONMENT=
+XBPS_CHECK_PKGS=
+XBPS_CROSS_BASE=
+XBPS_ENDIAN=
+XBPS_FETCH_CMD=
+XBPS_LIBC=
+XBPS_MACHINE=
+XBPS_MAKEJOBS=
+XBPS_NO_ATOMIC8=
+XBPS_RUST_TARGET=
+XBPS_SRCDISTDIR=
+XBPS_SRCPKGDIR=
+XBPS_TARGET_ENDIAN=
+XBPS_TARGET_LIBC=
+XBPS_TARGET_MACHINE=
+XBPS_TARGET_NO_ATOMIC8=
+XBPS_TARGET_WORDSIZE=
+XBPS_WORDSIZE=
+XBPS_WRAPPERDIR=
+makejobs=
+sourcepkg=
+
+# toolchain variables
+AR=
+AS=
+CC=
+CFLAGS=
+CPP=
+CPPFLAGS=
+CXX=
+CXXFLAGS=
+GCC=
+LD=
+LDFLAGS=
+LD_LIBRARY_PATH=
+NM=
+OBJCOPY=
+OBJDUMP=
+RANLIB=
+READELF=
+STRIP=
+
+# available variables
+allow_unknown_shlibs=
+alternatives=
+archs=
+binfmts=
+bootstrap=
+broken=
+build_helper=
+build_options=
+build_options_default=
+build_style=
+build_wrksrc=
+changelog=
+checkdepends=
+checksum=
+conf_files=
+configure_args=
+configure_script=
+conflicts=
+create_wrksrc=
+depends=
+disable_parallel_build=
+disable_parallel_check=
+distfiles=
+dkms_modules=
+fetch_cmd=
+font_dirs=
+force_debug_pkgs=
+gconf_entries=
+gconf_schemas=
+homepage=
+hostmakedepends=
+ignore_elf_dirs=
+ignore_elf_files=
+keep_libtool_archives=
+kernel_hooks_version=
+lib32depends=
+lib32disabled=
+lib32files=
+lib32mode=
+lib32symlinks=
+license=
+maintainer=
+make_build_args=
+make_build_target=
+make_check=
+make_check_args=
+make_check_pre=
+make_check_target=
+make_cmd=
+make_dirs=
+make_install_args=
+make_install_target=
+make_use_env=
+makedepends=
+mutable_files=
+no_generic_pkgconfig_link=
+nocheckperms=
+nocross=
+nodebug=
+nofixperms=
+nopie=
+nopie_files=
+noshlibprovides=
+nostrip=
+nostrip_files=
+noverifyrdeps=
+patch_args=
+perl_configure_dirs=
+pkgname=
+preserve=
+provides=
+register_shell=
+replaces=
+repository=
+restricted=
+reverts=
+revision=
+sgml_entries=
+shlib_provides=
+shlib_requires=
+short_desc=
+skip_extraction=
+skiprdeps=
+subpackages=
+system_accounts=
+system_groups=
+tags=
+triggers=
+version=
+wrksrc=
+xml_catalogs=
+xml_entries=
+
+# go
+go_build_tags=
+go_import_path=
+go_ldflags=
+go_mod_mode=
+go_package=
+
+# cmake
+cmake_builddir=
+
+# gemspec
+gem_cmd=
+
+# haskell-stack
+stackage=
+
+# meson
+meson_builddir=
+meson_cmd=
+meson_crossfile=
+
+# python*
+py2_inc=
+py2_lib=
+py2_sitelib=
+py2_ver=
+py3_inc=
+py3_lib=
+py3_sitelib=
+py3_ver=
+pycompile_dirs=
+pycompile_module=
+python_version=
+
+# void-cross
+cross_binutils_configure_args=
+cross_gcc_bootstrap_configure_args=
+cross_gcc_configure_args=
+cross_gcc_skip_go=
+cross_glibc_cflags=
+cross_glibc_configure_args=
+cross_glibc_ldflags=
+cross_musl_cflags=
+cross_musl_configure_args=
+cross_musl_ldflags=
+
+. template
+
+# global variables
+: "$CHROOT_READY"
+: "$CROSS_BUILD"
+: "$DESTDIR"
+: "$FILESDIR"
+: "$PKGDESTDIR"
+: "$XBPS_BUILDDIR"
+: "$XBPS_BUILD_ENVIRONMENT"
+: "$XBPS_CHECK_PKGS"
+: "$XBPS_CROSS_BASE"
+: "$XBPS_ENDIAN"
+: "$XBPS_FETCH_CMD"
+: "$XBPS_LIBC"
+: "$XBPS_MACHINE"
+: "$XBPS_MAKEJOBS"
+: "$XBPS_NO_ATOMIC8"
+: "$XBPS_RUST_TARGET"
+: "$XBPS_SRCDISTDIR"
+: "$XBPS_SRCPKGDIR"
+: "$XBPS_TARGET_ENDIAN"
+: "$XBPS_TARGET_LIBC"
+: "$XBPS_TARGET_MACHINE"
+: "$XBPS_TARGET_NO_ATOMIC8"
+: "$XBPS_TARGET_WORDSIZE"
+: "$XBPS_WORDSIZE"
+: "$XBPS_WRAPPERDIR"
+: "$makejobs"
+: "$sourcepkg"
+
+# toolchain variables
+: "$AR"
+: "$AS"
+: "$CC"
+: "$CFLAGS"
+: "$CPP"
+: "$CPPFLAGS"
+: "$CXX"
+: "$CXXFLAGS"
+: "$GCC"
+: "$LD"
+: "$LDFLAGS"
+: "$LD_LIBRARY_PATH"
+: "$NM"
+: "$OBJCOPY"
+: "$OBJDUMP"
+: "$RANLIB"
+: "$READELF"
+: "$STRIP"
+
+# available variables
+: "$allow_unknown_shlibs"
+: "$alternatives"
+: "$archs"
+: "$binfmts"
+: "$bootstrap"
+: "$broken"
+: "$build_helper"
+: "$build_options"
+: "$build_options_default"
+: "$build_style"
+: "$build_wrksrc"
+: "$changelog"
+: "$checkdepends"
+: "$checksum"
+: "$conf_files"
+: "$configure_args"
+: "$configure_script"
+: "$conflicts"
+: "$create_wrksrc"
+: "$depends"
+: "$disable_parallel_build"
+: "$disable_parallel_check"
+: "$distfiles"
+: "$dkms_modules"
+: "$fetch_cmd"
+: "$font_dirs"
+: "$force_debug_pkgs"
+: "$gconf_entries"
+: "$gconf_schemas"
+: "$homepage"
+: "$hostmakedepends"
+: "$ignore_elf_dirs"
+: "$ignore_elf_files"
+: "$keep_libtool_archives"
+: "$kernel_hooks_version"
+: "$lib32depends"
+: "$lib32disabled"
+: "$lib32files"
+: "$lib32mode"
+: "$lib32symlinks"
+: "$license"
+: "$maintainer"
+: "$make_build_args"
+: "$make_build_target"
+: "$make_check"
+: "$make_check_args"
+: "$make_check_pre"
+: "$make_check_target"
+: "$make_cmd"
+: "$make_dirs"
+: "$make_install_args"
+: "$make_install_target"
+: "$make_use_env"
+: "$makedepends"
+: "$mutable_files"
+: "$no_generic_pkgconfig_link"
+: "$nocheckperms"
+: "$nocross"
+: "$nodebug"
+: "$nofixperms"
+: "$nopie"
+: "$nopie_files"
+: "$noshlibprovides"
+: "$nostrip"
+: "$nostrip_files"
+: "$noverifyrdeps"
+: "$patch_args"
+: "$perl_configure_dirs"
+: "$pkgname"
+: "$preserve"
+: "$provides"
+: "$register_shell"
+: "$replaces"
+: "$repository"
+: "$restricted"
+: "$reverts"
+: "$revision"
+: "$sgml_entries"
+: "$shlib_provides"
+: "$shlib_requires"
+: "$short_desc"
+: "$skip_extraction"
+: "$skiprdeps"
+: "$subpackages"
+: "$system_accounts"
+: "$system_groups"
+: "$tags"
+: "$triggers"
+: "$version"
+: "$wrksrc"
+: "$xml_catalogs"
+: "$xml_entries"
+
+# go
+: "$go_build_tags"
+: "$go_import_path"
+: "$go_ldflags"
+: "$go_mod_mode"
+: "$go_package"
+
+# cmake
+: "$cmake_builddir"
+
+# gemspec
+: "$gem_cmd"
+
+# haskell-stack
+: "$stackage"
+
+# meson
+: "$meson_builddir"
+: "$meson_cmd"
+: "$meson_crossfile"
+
+# python*
+: "$py2_inc"
+: "$py2_lib"
+: "$py2_sitelib"
+: "$py2_ver"
+: "$py3_inc"
+: "$py3_lib"
+: "$py3_sitelib"
+: "$py3_ver"
+: "$pycompile_dirs"
+: "$pycompile_module"
+: "$python_version"
+
+# void-cross
+: "$cross_binutils_configure_args"
+: "$cross_gcc_bootstrap_configure_args"
+: "$cross_gcc_configure_args"
+: "$cross_gcc_skip_go"
+: "$cross_glibc_cflags"
+: "$cross_glibc_configure_args"
+: "$cross_glibc_ldflags"
+: "$cross_musl_cflags"
+: "$cross_musl_configure_args"
+: "$cross_musl_ldflags"

From 82ccedd90c85f7414eaf65e15b3ab0c63a918984 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 19 May 2023 16:14:14 -0400
Subject: [PATCH 2/6] .github/workflows/build.yaml: install shellcheck for
 xlint

---
 .github/workflows/build.yaml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index d860feff70d38..7def24d9d208c 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -25,6 +25,7 @@ jobs:
       env:
         PATH: '/usr/libexec/chroot-git:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/sbin:/usr/local/bin:/tmp/bin'
         LICENSE_LIST: common/travis/license.lst
+        XSHELLCHECK_ARGS: --color=always
 
     steps:
       - name: Prepare container
@@ -37,7 +38,7 @@ jobs:
           # Upgrade again (in case there was a xbps update)
           xbps-install -yu
           # install tools needed for lints
-          xbps-install -y grep curl
+          xbps-install -y grep curl shellcheck gawk
       - name: Clone and checkout
         uses: classabbyamp/treeless-checkout-action@v1
       - name: Create hostrepo and prepare masterdir

From fb65e10ac68f81f685a2217ecf00a2ad1f7cd38b Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 19 May 2023 16:14:57 -0400
Subject: [PATCH 3/6] common/travis/xlint.sh: run xshellcheck

---
 common/travis/xlint.sh | 1 +
 1 file changed, 1 insertion(+)

diff --git a/common/travis/xlint.sh b/common/travis/xlint.sh
index 0b2d12d0b0d04..b9f3333ccef3c 100755
--- a/common/travis/xlint.sh
+++ b/common/travis/xlint.sh
@@ -10,6 +10,7 @@ common/scripts/lint-commits $base $tip || EXITCODE=$?
 for t in $(awk '{ print "srcpkgs/" $0 "/template" }' /tmp/templates); do
 	/bin/echo -e "\x1b[32mLinting $t...\x1b[0m"
 	xlint "$t" > /tmp/xlint_out || EXITCODE=$?
+	xshellcheck "$t" || EXITCODE=$?
 	common/scripts/lint-version-change "$t" $base $tip > /tmp/vlint_out || EXITCODE=$?
 	awk -f common/scripts/lint2annotations.awk /tmp/xlint_out /tmp/vlint_out
 done

From 5e108410767a7580b5da09e2221278e1e29253b3 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 19 May 2023 16:15:17 -0400
Subject: [PATCH 4/6] TEMP: switch xtools fork/branch for xshellcheck

---
 common/travis/fetch-xtools.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/common/travis/fetch-xtools.sh b/common/travis/fetch-xtools.sh
index 0dd9e6c532c06..6795b1afc3132 100755
--- a/common/travis/fetch-xtools.sh
+++ b/common/travis/fetch-xtools.sh
@@ -4,7 +4,7 @@
 
 TAR=tar
 command -v bsdtar >/dev/null && TAR=bsdtar
-URL="https://github.com/leahneukirchen/xtools/archive/master.tar.gz"
+URL="https://github.com/classabbyamp/xtools/archive/xshellcheck.tar.gz"
 FILE="xtools.tar.gz"
 
 mkdir -p /tmp/bin

From 33012c402cc7be41724e66145ebeb18a33bd3575 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 19 May 2023 16:16:23 -0400
Subject: [PATCH 5/6] TEMP: something to shellcheck

---
 srcpkgs/chezmoi/template | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/srcpkgs/chezmoi/template b/srcpkgs/chezmoi/template
index 315131953a149..c24c9f9d8b999 100644
--- a/srcpkgs/chezmoi/template
+++ b/srcpkgs/chezmoi/template
@@ -14,6 +14,7 @@ homepage="https://chezmoi.io/"
 changelog="https://github.com/twpayne/chezmoi/releases"
 distfiles="https://github.com/twpayne/chezmoi/archive/v${version}.tar.gz"
 checksum=e2c30b9cf023c50083d5cacec36a73088d4bb31548f3251a3baa275717e20817
+bhasdfhsdf=
 
 pre_build() {
 	local _date
@@ -32,4 +33,5 @@ post_install() {
 	vcompletion completions/chezmoi-completion.bash bash
 	vcompletion completions/chezmoi.fish fish
 	vcompletion completions/chezmoi.zsh zsh
+	: $adfsdhfajhsdfjasdf
 }

From 049cb76df34dbbd8f8af9ea5fc165427b8b4ac63 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 19 May 2023 18:58:24 -0400
Subject: [PATCH 6/6] temp

---
 common/travis/xlint.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/common/travis/xlint.sh b/common/travis/xlint.sh
index b9f3333ccef3c..86da7069aa5f7 100755
--- a/common/travis/xlint.sh
+++ b/common/travis/xlint.sh
@@ -9,9 +9,9 @@ common/scripts/lint-commits $base $tip || EXITCODE=$?
 
 for t in $(awk '{ print "srcpkgs/" $0 "/template" }' /tmp/templates); do
 	/bin/echo -e "\x1b[32mLinting $t...\x1b[0m"
-	xlint "$t" > /tmp/xlint_out || EXITCODE=$?
+	xlint "$t" || EXITCODE=$? #> /tmp/xlint_out || EXITCODE=$?
 	xshellcheck "$t" || EXITCODE=$?
 	common/scripts/lint-version-change "$t" $base $tip > /tmp/vlint_out || EXITCODE=$?
-	awk -f common/scripts/lint2annotations.awk /tmp/xlint_out /tmp/vlint_out
+	# awk -f common/scripts/lint2annotations.awk /tmp/xlint_out /tmp/vlint_out
 done
 exit $EXITCODE