ci: add shellcheck; fix violations (#8753)

Author: alxndrsn

.github/workflows/ci.yml

@@ -28,6 +28,13 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
       - run: npm run eslint
 
+  shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: sudo apt-get install shellcheck
+      - run: git ls-files '*.sh' | xargs shellcheck
+
   # Run the integration, find and mapreduce tests against CouchDB on Node.js.
   # This should be run against every version of CouchDB and every version of
   # Node.js we support.

bin/build-node.sh

@@ -1,6 +1,6 @@
 #!/bin/bash -e
 
 # don't bother doing this in GHA because it's already been built
-if [ -z $GITHUB_REPOSITORY ]; then
+if [ -z "$GITHUB_REPOSITORY" ]; then
   BUILD_NODE=1 npm run build-modules
 fi

bin/publish-packages.sh

@@ -9,6 +9,7 @@ publish_packages () {
     return 0
   fi
 
+  # shellcheck disable=SC2207
   local pkgs=($(cat "$todo"))
   local failed='n'
 
@@ -43,7 +44,7 @@ should_publish () {
 
   if [ ! -d "packages/node_modules/$pkg" ]; then
     return 1
-  elif [ "true" = $(node --eval "console.log(require('./packages/node_modules/$pkg/package.json').private);") ]; then
+  elif [ "true" = "$(node --eval "console.log(require('./packages/node_modules/$pkg/package.json').private);")" ]; then
     return 1
   else
     return 0

bin/release.sh

@@ -1,8 +1,8 @@
 #!/bin/bash -e
 
-if [ ! -z $DRY_RUN ]; then
+if [ -n "$DRY_RUN" ]; then
   echo "Doing a dry run release..."
-elif [ ! -z $BETA ]; then
+elif [ -n "$BETA" ]; then
   echo "Doing a beta release to npm..."
 else
   echo "Doing a real release! Use DRY_RUN=1 for a dry run instead."
@@ -30,20 +30,20 @@ ls packages/node_modules > release-todo.txt
 # Create git tag, which is also the Bower/Github release
 rm -fr lib src dist bower.json component.json package.json
 cp -r packages/node_modules/pouchdb/{src,lib,dist,bower.json,component.json,package.json} .
-git add -f lib src dist *.json
+git add -f -- lib src dist *.json
 git rm -fr packages bin docs scripts tests
 
 git commit -m "build $VERSION"
 
 # Only "publish" to GitHub/Bower if this is a non-beta non-dry run
-if [ -z $DRY_RUN ]; then
- if [ -z $BETA ]; then
+if [ -z "$DRY_RUN" ]; then
+ if [ -z "$BETA" ]; then
     # Tag and push
-    git tag $VERSION
-    git push --tags git@github.com:pouchdb/pouchdb.git $VERSION
+    git tag "$VERSION"
+    git push --tags git@github.com:pouchdb/pouchdb.git "$VERSION"
 
     # Cleanup
-    git checkout $SOURCE_DIR
+    git checkout "$SOURCE_DIR"
     git branch -D $BUILD_DIR
   fi
 fi

bin/run-test.sh

@@ -1,19 +1,22 @@
 #!/bin/bash -e
+shopt -s nullglob
 
 cleanup() {
-  if [[ ! -z $SERVER_PID ]]; then
-    kill $SERVER_PID
+  if [[ -n $SERVER_PID ]]; then
+    kill "$SERVER_PID"
   fi
 }
 trap cleanup EXIT
 
 # Run tests against a local setup of pouchdb-express-router
 # by default unless COUCH_HOST is specified.
-[ -z "$COUCH_HOST" -a -z "$SERVER"  ] && SERVER="pouchdb-express-router"
+if [ -z "$COUCH_HOST" ] && [ -z "$SERVER"  ]; then
+  SERVER="pouchdb-express-router"
+fi
 
-: ${CLIENT:="node"}
-: ${COUCH_HOST:="http://127.0.0.1:5984"}
-: ${VIEW_ADAPTERS:="memory"}
+: "${CLIENT:=node}"
+: "${COUCH_HOST:=http://127.0.0.1:5984}"
+: "${VIEW_ADAPTERS:=memory}"
 export VIEW_ADAPTERS
 
 pouchdb-setup-server() {
@@ -34,9 +37,9 @@ pouchdb-setup-server() {
 
   TESTDIR=./tests/pouchdb_server
   rm -rf $TESTDIR && mkdir -p $TESTDIR
-  FLAGS="$POUCHDB_SERVER_FLAGS --dir $TESTDIR"
-  echo -e "Starting up pouchdb-server with flags: $FLAGS \n"
-  ./pouchdb-server-install/node_modules/.bin/pouchdb-server -n -p 6984 $FLAGS &
+  FLAGS=("$POUCHDB_SERVER_FLAGS" --dir "$TESTDIR")
+  echo -e "Starting up pouchdb-server with flags: ${FLAGS[*]} \n"
+  ./pouchdb-server-install/node_modules/.bin/pouchdb-server -n -p 6984 "${FLAGS[@]}" &
   export SERVER_PID=$!
 }
 
@@ -54,8 +57,8 @@ pouchdb-link-server-modules() {
   fi
 
   # internal node_modules of other packages
-  for subPkg in $(ls -d node_modules/**/node_modules/${pkg}/ 2>/dev/null); do
-    cd ${subPkg}../..
+  for subPkg in node_modules/**/node_modules/"$pkg"; do
+    cd "$subPkg/../.."
     echo -e "\nnpm link ${pkg} for ${subPkg}"
     npm link "${pkg}"
     cd ../..
@@ -79,7 +82,7 @@ pouchdb-build-node() {
   fi
 }
 
-if [[ ! -z $SERVER ]]; then
+if [[ -n $SERVER ]]; then
   if [ "$SERVER" == "pouchdb-server" ]; then
     export COUCH_HOST='http://127.0.0.1:6984'
     if [[ -n "$GITHUB_REPOSITORY" || "$COVERAGE" == 1 ]]; then
@@ -110,22 +113,22 @@ if [[ ! -z $SERVER ]]; then
 fi
 
 if [ "$SERVER" == "couchdb-master" ]; then
-  while [ '200' != $(curl -s -o /dev/null -w %{http_code} ${COUCH_HOST}) ]; do
+  while [ '200' != "$(curl -s -o /dev/null -w '%{http_code}' ${COUCH_HOST})" ]; do
     echo waiting for couch to load... ;
     sleep 1;
   done
 
   ./node_modules/.bin/add-cors-to-couchdb $COUCH_HOST
 fi
 
-printf "Waiting for host to start on $COUCH_HOST..."
+printf "Waiting for host to start on %s..." "$COUCH_HOST"
 WAITING=0
-until $(curl --output /dev/null --silent --head --fail --max-time 2 $COUCH_HOST); do
+until curl --output /dev/null --silent --head --fail --max-time 2 $COUCH_HOST; do
     if [ $WAITING -eq 4 ]; then
         printf '\nHost failed to start\n'
         exit 1
     fi
-    let WAITING=WAITING+1
+    ((WAITING=WAITING+1))
     printf '.'
     sleep 5
 done

bin/test-node.sh

@@ -1,9 +1,9 @@
 #!/bin/bash -e
 
-: ${TIMEOUT:=5000}
-: ${REPORTER:="spec"}
-: ${BAIL:=1}
-: ${TYPE:="integration"}
+: "${TIMEOUT:=5000}"
+: "${REPORTER:="spec"}"
+: "${BAIL:=1}"
+: "${TYPE:="integration"}"
 
 if [ $BAIL -eq 1 ]; then
     BAIL_OPT="--bail"
@@ -29,41 +29,41 @@ fi
 if [ $TYPE = "find" ]; then
     TESTS_PATH="tests/find/*/test.*.js"
 fi
-if [ $COVERAGE ]; then
+if [ "$COVERAGE" ]; then
     # run all tests when testing for coverage
     TESTS_PATH="tests/{unit,integration,mapreduce,component}/test*.js tests/find/*/test.*.js"
 fi
 
-if [ $PERF ]; then
+if [ "$PERF" ]; then
     node tests/performance/index.js
-elif [ ! $COVERAGE ]; then
+elif [ ! "$COVERAGE" ]; then
     # --exit required to workaround #8839
     ./node_modules/.bin/mocha \
         --exit \
-        $BAIL_OPT \
+        "$BAIL_OPT" \
         --timeout "$TIMEOUT" \
         --require=./tests/integration/node.setup.js \
         --reporter="$REPORTER" \
         --grep="$GREP" \
-        $TESTS_PATH
+        "$TESTS_PATH"
 else
     # --exit required to workaround #8839
     ./node_modules/.bin/istanbul cover \
        --no-default-excludes -x 'tests/**' -x 'node_modules/**' \
        ./node_modules/mocha/bin/_mocha -- \
         --exit \
-        $BAIL_OPT \
+        "$BAIL_OPT" \
         --timeout "$TIMEOUT" \
         --require=./tests/integration/node.setup.js \
         --reporter="$REPORTER" \
         --grep="$GREP" \
-        $TESTS_PATH
+        "$TESTS_PATH"
 
     ./node_modules/.bin/istanbul check-coverage --line 100
 fi
 
 EXIT_STATUS=$?
-if [[ ! -z $DOWN_SERVER_PID ]]; then
+if [[ -n $DOWN_SERVER_PID ]]; then
   kill $DOWN_SERVER_PID
 fi
 exit $EXIT_STATUS

bin/verify-bundle-size.sh

@@ -6,7 +6,7 @@ MAX=50000
 
 # testing pouchdb.js instead of pouchdb.min.js because minification isn't run in Travis
 # in order to make our builds faster
-SIZE=`./node_modules/.bin/terser -mc < packages/node_modules/pouchdb/dist/pouchdb.js 2>/dev/null | gzip -c | wc -c`
+SIZE=$(./node_modules/.bin/terser -mc < packages/node_modules/pouchdb/dist/pouchdb.js 2>/dev/null | gzip -c | wc -c)
 
 echo "Checking that pouchdb.min.js size $SIZE is less than $MAX and greater than 20"