implement shellcheck for linting

.pre-commit-config.yaml

@@ -9,6 +9,10 @@ repos:
       - id: check-docstring-first
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
   - repo: https://github.com/PyCQA/isort
     rev: 5.13.2
     hooks:

publish.sh

@@ -13,10 +13,10 @@
 #   (base) $ ./publish.sh
 #
 
-for f in $(find dist -name "*.whl"); do
-   echo "***** PUBLISH $f ***********************************"
-   anaconda upload -u beeware $f
-   if [[ $? == 0 ]]; then
-	   mv $f published
-   fi
-done
+while IFS= read -r -d '' FILE
+do
+    echo "***** PUBLISH $FILE ***********************************"
+    if anaconda upload -u beeware "$FILE"; then
+  	  mv "$FILE" published
+    fi
+done <  <(find ./dist -name "*.whl" -print0)

recipes/bzip2/build.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 set -eu
 
-mkdir -p $PREFIX
-cp -r include $PREFIX
-cp -r lib $PREFIX
+mkdir -p "$PREFIX"
+cp -r include "$PREFIX"
+cp -r lib "$PREFIX"
 
 # Strip out any dylib files to ensure static linking
-find $PREFIX -name "*.dylib" -exec rm -rf {} \;
+find "$PREFIX" -name '*.dylib' -exec rm -rf {} \;

recipes/freetype/build.sh

@@ -2,8 +2,8 @@
 set -eu
 
 ./configure \
-    --host=$HOST_TRIPLET \
-    --build=$BUILD_TRIPLET \
+    --host="$HOST_TRIPLET" \
+    --build="$BUILD_TRIPLET" \
     --enable-static \
     --without-harfbuzz \
     --without-png \
@@ -12,15 +12,15 @@ set -eu
     ZLIB_CFLAGS="-I$INSTALL_ROOT/include" \
     ZLIB_LIBS="-L$INSTALL_ROOT/lib -lz"
 
-make -j $CPU_COUNT
-make install prefix=$PREFIX
+make -j "$CPU_COUNT"
+make install prefix="$PREFIX"
 
-mv $PREFIX/include/freetype2/* $PREFIX/include
-rmdir $PREFIX/include/freetype2
+mv "$PREFIX/include/freetype2/"* "$PREFIX/include"
+rmdir "$PREFIX/include/freetype2"
 
 # Some versions of Android (e.g. API level 26) have a libft2.so in /system/lib, but our copy
 # has an SONAME of libfreetype.so, so there's no conflict.
 # rm -r $PREFIX/lib/{*.a,*.la,pkgconfig}
-rm -r $PREFIX/lib/{*.la,pkgconfig}
+rm -r "$PREFIX/lib/"{*.la,pkgconfig}
 
-rm -r $PREFIX/share
+rm -r "$PREFIX/share"

recipes/libffi/build.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 set -eu
 
-mkdir -p $PREFIX
-cp -r include $PREFIX
-cp -r lib $PREFIX
+mkdir -p "$PREFIX"
+cp -r include "$PREFIX"
+cp -r lib "$PREFIX"
 
 # Strip out any dylib files to ensure static linking
-find $PREFIX -name "*.dylib" -exec rm -rf {} \;
+find "$PREFIX" -name '*.dylib' -exec rm -rf {} \;

recipes/libjpeg/build.sh

@@ -2,10 +2,15 @@
 set -eu
 
 # SIMD is only available for x86, so disable for consistency between ABIs.
-./configure --host=$HOST_TRIPLET --build=$BUILD_TRIPLET --without-turbojpeg --without-simd
-make -j $CPU_COUNT
-make install prefix=$PREFIX
+./configure \
+  --host="$HOST_TRIPLET" \
+  --build="$BUILD_TRIPLET" \
+  --without-turbojpeg \
+  --without-simd
+make -j "$CPU_COUNT"
+make install prefix="$PREFIX"
 
-rm -r $PREFIX/{bin,doc,man}
-mv $PREFIX/lib?? $PREFIX/lib  # lib32 or lib64
-rm -r $PREFIX/lib/{*.la,pkgconfig}
+# do not unintentionally delete /bin
+rm -r "{$PREFIX:?}/"{bin,doc,man}
+mv "$PREFIX/lib"?? "$PREFIX/lib"  # lib32 or lib64
+rm -r "$PREFIX/lib/"{*.la,pkgconfig}

recipes/libpng/build.sh

@@ -1,22 +1,23 @@
 #!/bin/bash
 set -eu
 
-./configure --host=$HOST_TRIPLET --build=$BUILD_TRIPLET
-make -j $CPU_COUNT
-make install prefix=$PREFIX
+./configure --host="$HOST_TRIPLET" --build="$BUILD_TRIPLET"
+make -j "$CPU_COUNT"
+make install prefix="$PREFIX"
 
-find $PREFIX -type l | xargs rm
+find "$PREFIX" -type l -print0 | xargs -0 rm
 
-rm -r $PREFIX/bin
+# do not unintentionally delete /bin
+rm -r "${PREFIX:?}/bin"
 
-mv $PREFIX/include/libpng16/* $PREFIX/include
-rmdir $PREFIX/include/libpng16
+mv "$PREFIX/include/libpng16/"* "$PREFIX/include"
+rmdir "$PREFIX/include/libpng16"
 
 # Some versions of Android (e.g. API level 26) have a libpng.so in /system/lib, but our copy
 # has an SONAME of libpng16.so, so there's no conflict.
-# rm -r $PREFIX/lib/{*.a,*.la,pkgconfig}
+# rm -r "$PREFIX/lib/"{*.a,*.la,pkgconfig}
 
 # Downstream recipes expect the name libpng.a, not libpng16.a
-mv $PREFIX/lib/libpng16.a $PREFIX/lib/libpng.a
+mv "$PREFIX/lib/libpng16.a" "$PREFIX/lib/libpng.a"
 
-rm -r $PREFIX/share
+rm -r "$PREFIX/share"

recipes/lru-dict/test_lru_dict.py

@@ -5,6 +5,5 @@ def test_basic():
     data[1] = None
     data[2] = None
     data[3] = None
-    data[1]
     data[4] = None
     assert data.keys == [4, 1, 3]

recipes/ninja/build.sh

@@ -1,15 +1,15 @@
 #!/bin/bash
 set -eu
 
-mkdir -p $PREFIX
+mkdir -p "$PREFIX"
 cp -r ninja wheel
 
 # Ensure the binary is executable
 chmod +x wheel/ninja/data/bin/ninja
 
 # Write the metadata for the entry point script
-mkdir -p wheel/ninja-$VERSION.dist-info
-cat << EOF > wheel/ninja-$VERSION.dist-info/entry_points.txt
+mkdir -p "wheel/ninja-$VERSION.dist-info"
+cat << EOF > "wheel/ninja-$VERSION.dist-info/entry_points.txt"
 [console_scripts]
 ninja = ninja:ninja
 EOF

recipes/openssl/build.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 set -eu
 
-mkdir -p $PREFIX
-cp -r include $PREFIX
-cp -r lib $PREFIX
+mkdir -p "$PREFIX"
+cp -r include "$PREFIX"
+cp -r lib "$PREFIX"
 
 # Strip out any dylib files to ensure static linking
-find $PREFIX -name "*.dylib" -exec rm -rf {} \;
+find "$PREFIX" -name '*.dylib' -exec rm -rf {} \;

recipes/pillow/test/test_pillow.py

@@ -29,5 +29,5 @@ def test_font():
     from PIL import ImageFont
 
     font = ImageFont.truetype(join(dirname(__file__), "Vera.ttf"), size=20)
-    font.getsize("Hello") == (51, 19)
-    font.getsize("Hello world") == (112, 19)
+    assert font.getsize("Hello") == (51, 19)
+    assert font.getsize("Hello world") == (112, 19)

recipes/xz/build.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 set -eu
 
-mkdir -p $PREFIX
-cp -r include $PREFIX
-cp -r lib $PREFIX
+mkdir -p "$PREFIX"
+cp -r include "$PREFIX"
+cp -r lib "$PREFIX"
 
 # Strip out any dylib files to ensure static linking
-find $PREFIX -name "*.dylib" -exec rm -rf {} \;
+find "$PREFIX" -name '*.dylib' -exec rm -rf {} \;

setup-iOS.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 # set -e
 
 usage() {
@@ -16,20 +18,20 @@ usage() {
 if [ "${BASH_SOURCE[0]}" = "$0" ]; then
     echo "This script must be sourced."
     echo
-    usage $0
+    usage "$0"
     exit 1
 fi
 
 if [ -z "$1" ]; then
     echo "Python version is not provided."
     echo
-    usage $0
+    usage "$0"
     return
 fi
 
 PYTHON_VER=$1
 
-if [ ! -z "$VIRTUAL_ENV" ]; then
+if [ -n "$VIRTUAL_ENV" ]; then
     echo "A virtual environment is already active; deactivate that environment before calling this script."
     return
 fi
@@ -41,7 +43,8 @@ mkdir -p downloads
 mkdir -p published
 
 if [ -z "$PYTHON_APPLE_SUPPORT" ]; then
-    export MOBILE_FORGE_SUPPORT_PATH=$(pwd)/support
+    MOBILE_FORGE_SUPPORT_PATH="$(pwd)/support"
+    export MOBILE_FORGE_SUPPORT_PATH
 
     if [ ! -d "$MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS" ]; then
         if [ -z "$2" ]; then
@@ -62,49 +65,52 @@ if [ -z "$PYTHON_APPLE_SUPPORT" ]; then
 
         if [ ! -e "downloads/Python-${PYTHON_VER}-iOS-support.b${SUPPORT_REVISION}.tar.gz" ]; then
             echo "Downloading Python ${PYTHON_VER} b${SUPPORT_REVISION} support package"
-            curl --location "https://github.com/beeware/Python-Apple-support/releases/download/${PYTHON_VER}-b${SUPPORT_REVISION}/Python-${PYTHON_VER}-iOS-support.b${SUPPORT_REVISION}.tar.gz" --output downloads/Python-${PYTHON_VER}-iOS-support.b${SUPPORT_REVISION}.tar.gz
+            curl \
+              --location "https://github.com/beeware/Python-Apple-support/releases/download/${PYTHON_VER}-b${SUPPORT_REVISION}/Python-${PYTHON_VER}-iOS-support.b${SUPPORT_REVISION}.tar.gz" \
+              --output "downloads/Python-${PYTHON_VER}-iOS-support.b${SUPPORT_REVISION}.tar.gz"
         fi
 
         echo "Unpacking Python ${PYTHON_VER} b${SUPPORT_REVISION} support package"
-        mkdir -p $MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS
-        pushd $MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS
-        tar zxf ../../../downloads/Python-${PYTHON_VER}-iOS-support.b${SUPPORT_REVISION}.tar.gz
-        popd
+        mkdir -p "$MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS"
+        pushd "$MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS" || exit
+        tar zxf "../../../downloads/Python-${PYTHON_VER}-iOS-support.b${SUPPORT_REVISION}.tar.gz"
+        popd || exit
     fi
 else
-    export MOBILE_FORGE_SUPPORT_PATH=$PYTHON_APPLE_SUPPORT/support
+    export MOBILE_FORGE_SUPPORT_PATH="$PYTHON_APPLE_SUPPORT/support"
 fi
 echo "Using $MOBILE_FORGE_SUPPORT_PATH as the support folder"
 
-BUILD_PYTHON=$(which python$PYTHON_VER)
-if [ $? -ne 0 ]; then
+BUILD_PYTHON=$(which "python$PYTHON_VER")
+if [ -z "$BUILD_PYTHON" ]; then
     echo "Can't find a Python $PYTHON_VER binary on the path."
     return
 fi
 
-if [ ! -e $MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS/Python.xcframework/ios-arm64/bin/python$PYTHON_VER ]; then
+if [ ! -e "$MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS/Python.xcframework/ios-arm64/bin/python$PYTHON_VER" ]; then
     echo "Support folder does not appear to contain a Python $PYTHON_VER iOS device binary."
     return
 fi
 
-if [ ! -e $MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS/Python.xcframework/ios-arm64_x86_64-simulator/bin/python$PYTHON_VER ]; then
+if [ ! -e "$MOBILE_FORGE_SUPPORT_PATH/$PYTHON_VER/iOS/Python.xcframework/ios-arm64_x86_64-simulator/bin/python$PYTHON_VER" ]; then
     echo "Support folder does not appear to contain a Python $PYTHON_VER iOS simulator binary."
     return
 fi
 
-if [ ! -d ./venv$PYTHON_VER ]; then
+if [ ! -d "./venv$PYTHON_VER" ]; then
     echo "Creating Python $PYTHON_VER virtual environment for build..."
     echo "Using $BUILD_PYTHON as the build python"
-    $BUILD_PYTHON -m venv venv$PYTHON_VER
+    $BUILD_PYTHON -m venv "venv$PYTHON_VER"
 
-    source ./venv$PYTHON_VER/bin/activate
+    # shellcheck disable=SC1090
+    source "./venv$PYTHON_VER/bin/activate"
 
     # Install basic environment artefacts
     pip install -U pip
-    pip install -U setuptools
-    pip install -e . wheel
+    pip install -U setuptools wheel
+    pip install -e .
 
-    echo "Python $PYTHON_VERSION environment has been created."
+    echo "Python $PYTHON_VER environment has been created."
     echo
     echo "You can now build packages with forge; e.g.:"
     echo
@@ -128,5 +134,6 @@ if [ ! -d ./venv$PYTHON_VER ]; then
     echo
 else
     echo "Using existing Python $PYTHON_VER environment."
-    source ./venv$PYTHON_VER/bin/activate
+    # shellcheck disable=SC1090
+    source "./venv$PYTHON_VER/bin/activate"
 fi