refactor: move all shellcheck disable definitions to .shellcheckrc file

This makes standard use of shellcheck work without needing to provide extra configuration anywhere. Also remove use of inline 'shellcheck disable' calls that are already defined in the .shellcheckrc and don't need to be set inline.
2023-07-01 04:21:46 -04:00
parent 4436bb2023
commit dac566e75e
36 changed files with 32 additions and 113 deletions
--- a/plugins/20_events/install
+++ b/plugins/20_events/install
@@ -14,7 +14,6 @@ trigger-events-install() {

  # This can be done unconditionally as mkdir -p
  # exits gracefully if the path already exists
-  # shellcheck disable=SC2174
  mkdir -m 775 -p "$DOKKU_LOGS_DIR"
  case "$DOKKU_DISTRO" in
    arch | debian | raspbian)
--- a/plugins/builder-lambda/builder-build
+++ b/plugins/builder-lambda/builder-build
@@ -20,7 +20,6 @@ trigger-builder-lambda-builder-build() {

  plugn trigger pre-build-lambda "$APP"

-  # shellcheck disable=SC2086
  lambda-builder build --generate-image --write-procfile --image-env=DOCKER_LAMBDA_STAY_OPEN=1 --label=org.label-schema.schema-version=1.0 --label=org.label-schema.vendor=dokku --label=com.dokku.image-stage=build --label=com.dokku.builder-type=lambda "--label=com.dokku.app-name=$APP" $DOKKU_GLOBAL_BUILD_ARGS --port 5000 --tag "$IMAGE" --working-directory "$SOURCECODE_WORK_DIR"
  if [[ ! -f "$SOURCECODE_WORK_DIR/lambda.zip" ]]; then
    dokku_log_warn "Compressed lambda.zip not detected, failed to build lambda function"
--- a/plugins/docker-options/docker-args-deploy
+++ b/plugins/docker-options/docker-args-deploy
@@ -33,7 +33,6 @@ trigger-docker-options-docker-args() {

      [[ -z "$line" ]] && continue

-      # shellcheck disable=SC1001
      case "$line" in
        \#*)
          continue
--- a/plugins/docker-options/subcommands/remove
+++ b/plugins/docker-options/subcommands/remove
@@ -13,7 +13,6 @@ cmd-docker-options-remove() {
  verify_app_name "$APP"
  read -ra passed_phases <<<"$(get_phases "$2")"
  shift 2 # everything else passed is the docker option
-  # shellcheck disable=SC2154
  [[ -z ${passed_docker_option="$@"} ]] && dokku_log_fail "Please specify docker options to remove from the phase"
  remove_passed_docker_option passed_phases[@] "${passed_docker_option[@]}"
 }
--- a/plugins/domains/functions
+++ b/plugins/domains/functions
@@ -16,7 +16,6 @@ disable_app_vhost() {
  fi

  [[ "$RESTART_APP" == "--no-restart" ]] && local CONFIG_SET_ARGS=$RESTART_APP
-  # shellcheck disable=SC2086
  DOKKU_QUIET_OUTPUT=1 config_set $CONFIG_SET_ARGS $APP NO_VHOST=1
 }

@@ -196,7 +195,6 @@ enable_app_vhost() {

  plugn trigger pre-enable-vhost "$APP"
  [[ "$RESTART_APP" == "--no-restart" ]] && local CONFIG_SET_ARGS=$RESTART_APP
-  # shellcheck disable=SC2086
  DOKKU_QUIET_OUTPUT=1 config_set $CONFIG_SET_ARGS "$APP" NO_VHOST=0
 }

--- a/plugins/git/git-from-directory
+++ b/plugins/git/git-from-directory
@@ -15,7 +15,6 @@ trigger-git-git-from-directory() {
  local REV
  local TMP_WORK_DIR=$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
  local TMP_WORK_DIR_2=$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
-  # shellcheck disable=SC2086
  trap "rm -rf '$TMP_WORK_DIR' '$TMP_WORK_DIR_2' >/dev/null" RETURN INT TERM EXIT

  local has_code=true
--- a/plugins/nginx-vhosts/functions
+++ b/plugins/nginx-vhosts/functions
@@ -406,7 +406,6 @@ nginx_build_config() {
      local NGINX_BUILD_CONFIG_TMP_WORK_DIR=$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
      local NGINX_CONF=$(mktemp --tmpdir="${NGINX_BUILD_CONFIG_TMP_WORK_DIR}" "nginx.conf.XXXXXX")
      local CUSTOM_NGINX_TEMPLATE="$NGINX_BUILD_CONFIG_TMP_WORK_DIR/$NGINX_TEMPLATE_NAME"
-      # shellcheck disable=SC2086
      trap "rm -rf '$NGINX_CONF' '$NGINX_BUILD_CONFIG_TMP_WORK_DIR' >/dev/null" RETURN INT TERM EXIT

      get_custom_nginx_template "$APP" "$CUSTOM_NGINX_TEMPLATE" 2>/dev/null
--- a/plugins/scheduler-docker-local/bin/scheduler-deploy-process
+++ b/plugins/scheduler-docker-local/bin/scheduler-deploy-process
@@ -24,7 +24,6 @@ main() {
      # Disable the container restart policy
      "$DOCKER_BIN" container update --restart=no "$cid" &>/dev/null || true

-      # shellcheck disable=SC2086
      "$DOCKER_BIN" container stop $DOCKER_STOP_TIME_ARG "$cid" &>/dev/null
    done
  fi
--- a/plugins/scheduler-docker-local/check-deploy
+++ b/plugins/scheduler-docker-local/check-deploy
@@ -147,10 +147,8 @@ trigger-scheduler-docker-local-check-deploy() {
  local FAILEDCHECKS=0
  while read -r CHECK_URL EXPECTED; do
    # Ignore empty lines and lines starting with #
-    # shellcheck disable=SC1001
    [[ -z "$CHECK_URL" || "$CHECK_URL" =~ ^\# ]] && continue
    # Ignore if it's not a URL in a supported format
-    # shellcheck disable=SC1001
    ! [[ "$CHECK_URL" =~ ^(http(s)?:)?\/.* ]] && continue

    if [[ "$CHECK_URL" =~ ^https?: ]]; then
@@ -204,7 +202,6 @@ trigger-scheduler-docker-local-check-deploy() {
      sleep "$WAIT"

      # Capture HTTP response or CURL error message
-      # shellcheck disable=SC2086
      if OUTPUT=$(curl -# $CURL_ARGS 2>&1); then
        # OUTPUT contains the HTTP response
        # shellcheck disable=SC2076
--- a/plugins/scheduler-docker-local/internal-functions
+++ b/plugins/scheduler-docker-local/internal-functions
@@ -88,7 +88,6 @@ fn-scheduler-docker-local-retire-container() {
    # Attempt to stop, if that fails, then force a kill as docker seems
    # to not send SIGKILL as the docs would indicate. If that fails, move
    # on to the next.
-    # shellcheck disable=SC2086
    "$DOCKER_BIN" container stop $DOCKER_STOP_TIME_ARG "$CID" \
      || "$DOCKER_BIN" container kill "$CID" \
      || dokku_log_warn "Unable to kill container ${CID}"
--- a/plugins/scheduler-docker-local/post-delete
+++ b/plugins/scheduler-docker-local/post-delete
@@ -13,7 +13,6 @@ trigger-scheduler-docker-local-post-delete() {
  rm -rf "${DOKKU_LIB_ROOT}/data/scheduler-docker-local/$APP"

  # remove all application containers
-  # shellcheck disable=SC2046
  "$DOCKER_BIN" container ls --filter "label=com.dokku.app-name=${APP}" -q | xargs -n1 -I {} "$DOCKER_BIN" container rm --force {} &>/dev/null || true
 }

--- a/plugins/scheduler-docker-local/pre-deploy
+++ b/plugins/scheduler-docker-local/pre-deploy
@@ -58,7 +58,6 @@ scheduler-docker-local-pre-deploy-chown-app() {
    return
  fi

-  # shellcheck disable=SC2086
  "$DOCKER_BIN" container run --rm "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS "${ARG_ARRAY[@]}" $IMAGE /bin/bash -c "find $CONTAINER_PATHS -not -user $DOKKU_APP_USER -print0 | xargs -0 -r chown -R $DOKKU_APP_USER" || true
 }

--- a/plugins/scheduler-docker-local/scheduler-deploy
+++ b/plugins/scheduler-docker-local/scheduler-deploy
@@ -88,7 +88,6 @@ trigger-scheduler-docker-local-scheduler-deploy() {
        # Attempt to stop, if that fails, then force a kill as docker seems
        # to not send SIGKILL as the docs would indicate. If that fails, move
        # on to the next.
-        # shellcheck disable=SC2086
        "$DOCKER_BIN" container stop $DOCKER_STOP_TIME_ARG "$oldid" \
          || "$DOCKER_BIN" container kill "$oldid" \
          || plugn trigger retire-container-failed "$APP" "$oldid" # plugin trigger for event logging
--- a/plugins/scheduler-docker-local/scheduler-enter
+++ b/plugins/scheduler-docker-local/scheduler-enter
@@ -74,7 +74,6 @@ trigger-scheduler-docker-local-scheduler-enter() {
  local IMAGE="$("$DOCKER_BIN" container inspect --format '{{ .Config.Image }}' "$CONTAINER_ID")"
  is_image_herokuish_based "$IMAGE" "$APP" && EXEC_CMD="/exec"
  is_image_cnb_based "$IMAGE" && EXEC_CMD="" && DOKKU_RUN_OPTS+=" -w /workspace"
-  # shellcheck disable=SC2086
  "$DOCKER_BIN" container exec $DOKKU_RUN_OPTS "$CONTAINER_ID" $EXEC_CMD "${@:-$DOKKU_APP_SHELL}"
 }

--- a/plugins/scheduler-docker-local/scheduler-run-stop
+++ b/plugins/scheduler-docker-local/scheduler-run-stop
@@ -13,7 +13,6 @@ fn-scheduler-docker-local-stop-container() {
  fi

  [[ $DOKKU_DOCKER_STOP_TIMEOUT ]] && DOCKER_STOP_TIME_ARG="--time=${DOKKU_DOCKER_STOP_TIMEOUT}"
-  # shellcheck disable=SC2086
  if "$DOCKER_BIN" container stop $DOCKER_STOP_TIME_ARG "$CONTAINER_ID_OR_NAME"; then
    return
  fi
--- a/plugins/scheduler-docker-local/scheduler-stop
+++ b/plugins/scheduler-docker-local/scheduler-stop
@@ -20,10 +20,8 @@ trigger-scheduler-docker-local-scheduler-stop() {

  if [[ -n "$DOKKU_APP_RUNNING_CONTAINER_IDS" ]]; then
    # Disable the container restart policy
-    # shellcheck disable=SC2086
    "$DOCKER_BIN" container update --restart=no $DOKKU_APP_RUNNING_CONTAINER_IDS &>/dev/null || true

-    # shellcheck disable=SC2086
    "$DOCKER_BIN" container stop $DOCKER_STOP_TIME_ARG $DOKKU_APP_RUNNING_CONTAINER_IDS >/dev/null || true
  fi

@@ -35,7 +33,6 @@ trigger-scheduler-docker-local-scheduler-stop() {
        plugn trigger scheduler-register-retired "$APP" "$CID"
      done

-      # shellcheck disable=SC2086
      "$DOCKER_BIN" container rm --force $DOKKU_APP_CIDS >/dev/null 2>&1 || true
    fi
  fi
--- a/plugins/shell/subcommands/default
+++ b/plugins/shell/subcommands/default
@@ -44,7 +44,6 @@ cmd-shell-default() {

      # Not a built-in, run as regular dokku command
      *)
-        # shellcheck disable=SC2086
        dokku $line || true
        ;;
    esac