chore: address ShellCheck issues

bzlformat/tools/buildifier.sh

@@ -16,18 +16,19 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 fail_sh_location=cgrindel_bazel_starlib/shlib/lib/fail.sh
 fail_sh="$(rlocation "${fail_sh_location}")" || \
   (echo >&2 "Failed to locate ${fail_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/fail.sh
 source "${fail_sh}"
 
 arrays_sh_location=cgrindel_bazel_starlib/shlib/lib/arrays.sh
 arrays_sh="$(rlocation "${arrays_sh_location}")" || \
   (echo >&2 "Failed to locate ${arrays_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/arrays.sh
 source "${arrays_sh}"
 
 buildifier_location=buildifier_prebuilt/buildifier/buildifier
 buildifier="$(rlocation "${buildifier_location}")" || \
   (echo >&2 "Failed to locate ${buildifier_location}" && exit 1)
 
-
 # MARK - Process Args
 
 # Lint Mode
@@ -40,8 +41,9 @@ lint_mode="off"
 warnings="all"
 
 get_usage() {
-  local utility="$(basename "${BASH_SOURCE[0]}")"
-  echo "$(cat <<-EOF
+  local utility
+  utility="$(basename "${BASH_SOURCE[0]}")"
+  cat <<-EOF
 Executes buildifier for a Starlark file and writes the resulting output to a file.
 
 Usage:
@@ -53,15 +55,13 @@ Options:
   <input>                  A path to a Starlark file
   <output>                 A path where to write the output from buildifier
 EOF
-  )"
 }
 
 args=()
 while (("$#")); do
   case "${1}" in
     "--help")
       show_usage
-      exit 0
       ;;
     "--lint_mode")
       lint_mode="${2}"
@@ -81,9 +81,9 @@ while (("$#")); do
   esac
 done
 
-[[ ${#args[@]} < 1 ]] && usage_error "Expected a path to a Starlark file."
+[[ ${#args[@]} -lt 1 ]] && usage_error "Expected a path to a Starlark file."
 bzl_path="${args[0]}"
-[[ ${#args[@]} > 1 ]] && out_path="${args[1]}"
+[[ ${#args[@]} -gt 1 ]] && out_path="${args[1]}"
 
 contains_item "${lint_mode}" "${lint_modes[@]}" || \
   usage_error "Invalid lint_mode (${lint_mode}). Expected to be one of the following: $( join_by ", " "${lint_modes[@]}" )."
@@ -95,7 +95,7 @@ exec_buildifier() {
   local bzl_path="${1}"
   shift 1
   local buildifier_cmd=( "${buildifier}" "--path=${bzl_path}" )
-  [[ ${#} > 0 ]] && buildifier_cmd+=( "${@}" )
+  [[ ${#} -gt 0 ]] && buildifier_cmd+=( "${@}" )
   "${buildifier_cmd[@]}"
 }
 

bzlformat/tools/missing_pkgs/find.sh

@@ -12,11 +12,13 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 # --- end runfiles.bash initialization v3 ---
 
 arrays_lib="$(rlocation cgrindel_bazel_starlib/shlib/lib/arrays.sh)"
+# shellcheck source=SCRIPTDIR/../../../shlib/lib/arrays.sh
 source "${arrays_lib}"
 
 common_sh_location=cgrindel_bazel_starlib/bzlformat/tools/missing_pkgs/common.sh
 common_sh="$(rlocation "${common_sh_location}")" || \
   (echo >&2 "Failed to locate ${common_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/common.sh
 source "${common_sh}"
 
 query_for_pkgs() {
@@ -49,8 +51,14 @@ done
 cd "${BUILD_WORKSPACE_DIRECTORY}"
 
 # The output `package` appears to sort the results
-all_pkgs=( $(query_for_pkgs //...) )
-pkgs_with_format=( $(query_for_pkgs 'kind(bzlformat_format, //...)') )
+all_pkgs=()
+while IFS=$'\n' read -r line; do all_pkgs+=("$line"); done < <(
+  query_for_pkgs //...
+)
+pkgs_with_format=()
+while IFS=$'\n' read -r line; do pkgs_with_format+=("$line"); done < <(
+  query_for_pkgs 'kind(bzlformat_format, //...)'
+)
 
 pkgs_missing_format=()
 for pkg in "${all_pkgs[@]}" ; do
@@ -59,7 +67,7 @@ for pkg in "${all_pkgs[@]}" ; do
   fi
 done
 
-if [[ ${#pkgs_missing_format[@]} > 0 ]]; then
+if [[ ${#pkgs_missing_format[@]} -gt 0 ]]; then
   # Output the missing packages.
   print_by_line "${pkgs_missing_format[@]:-}"
 

bzlformat/tools/missing_pkgs/fix.sh

@@ -14,13 +14,16 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 # --- end runfiles.bash initialization v3 ---
 
 arrays_lib="$(rlocation cgrindel_bazel_starlib/shlib/lib/arrays.sh)"
+# shellcheck source=SCRIPTDIR/../../../shlib/lib/arrays.sh
 source "${arrays_lib}"
 
 common_sh_location=cgrindel_bazel_starlib/bzlformat/tools/missing_pkgs/common.sh
 common_sh="$(rlocation "${common_sh_location}")" || \
   (echo >&2 "Failed to locate ${common_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/common.sh
 source "${common_sh}"
 
+# shellcheck source=SCRIPTDIR/find.sh
 find_missing_pkgs_bin="$(rlocation cgrindel_bazel_starlib/bzlformat/tools/missing_pkgs/find.sh)"
 
 buildozer_location=buildifier_prebuilt/buildozer/buildozer
@@ -32,7 +35,7 @@ args=()
 while (("$#")); do
   case "${1}" in
     "--exclude")
-      exclude_pkgs+=( $(normalize_pkg "${2}") )
+      exclude_pkgs+=( "$(normalize_pkg "${2}")" )
       shift 2
       ;;
     *)
@@ -49,10 +52,13 @@ find_args=()
 for pkg in "${exclude_pkgs[@]:-}" ; do
   find_args+=(--exclude "${pkg}")
 done
-missing_pkgs=( $(. "${find_missing_pkgs_bin}" "${find_args[@]:-}") )
+missing_pkgs=()
+while IFS=$'\n' read -r line; do missing_pkgs+=("$line"); done < <(
+  "${find_missing_pkgs_bin}" "${find_args[@]:-}"
+)
 
 # If no missing packages, we are done.
-[[ ${#missing_pkgs[@]} == 0 ]] && echo "No missing package updates were found." && exit
+[[ ${#missing_pkgs[@]} -eq 0 ]] && echo "No missing package updates were found." && exit
 
 echo "Updating the following packages:"
 for pkg in "${missing_pkgs[@]}" ; do

bzlrelease/tools/create_release.sh

@@ -16,21 +16,25 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 fail_sh_location=cgrindel_bazel_starlib/shlib/lib/fail.sh
 fail_sh="$(rlocation "${fail_sh_location}")" || \
   (echo >&2 "Failed to locate ${fail_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/fail.sh
 source "${fail_sh}"
 
 env_sh_location=cgrindel_bazel_starlib/shlib/lib/env.sh
 env_sh="$(rlocation "${env_sh_location}")" || \
   (echo >&2 "Failed to locate ${env_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/env.sh
 source "${env_sh}"
 
 git_sh_location=cgrindel_bazel_starlib/shlib/lib/git.sh
 git_sh="$(rlocation "${git_sh_location}")" || \
   (echo >&2 "Failed to locate ${git_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/git.sh
 source "${git_sh}"
 
 github_sh_location=cgrindel_bazel_starlib/shlib/lib/github.sh
 github_sh="$(rlocation "${github_sh_location}")" || \
   (echo >&2 "Failed to locate ${github_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/github.sh
 source "${github_sh}"
 
 
@@ -42,8 +46,9 @@ is_installed gh || fail "Could not find Github CLI (gh)."
 # MARK - Usage
 
 get_usage() {
-  local utility="$(basename "${BASH_SOURCE[0]}")"
-  echo "$(cat <<-EOF
+  local utility
+  utility="$(basename "${BASH_SOURCE[0]}")"
+  cat <<-EOF
 Execute a Github Action workflow to create a relase with the specified tag.
 
 Usage:
@@ -59,7 +64,6 @@ Options:
   --reset_tag         If specified and if a release does not exist for the tag,
                       the existing tag will be deleted and a new one created.
 EOF
-  )"
 }
 
 
@@ -72,7 +76,6 @@ while (("$#")); do
   case "${1}" in
     "--help")
       show_usage
-      exit 0
       ;;
     --workflow)
       workflow_name="${2}"

bzlrelease/tools/create_release_tag.sh

@@ -16,21 +16,25 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 fail_sh_location=cgrindel_bazel_starlib/shlib/lib/fail.sh
 fail_sh="$(rlocation "${fail_sh_location}")" || \
   (echo >&2 "Failed to locate ${fail_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/fail.sh
 source "${fail_sh}"
 
 env_sh_location=cgrindel_bazel_starlib/shlib/lib/env.sh
 env_sh="$(rlocation "${env_sh_location}")" || \
   (echo >&2 "Failed to locate ${env_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/env.sh
 source "${env_sh}"
 
 git_sh_location=cgrindel_bazel_starlib/shlib/lib/git.sh
 git_sh="$(rlocation "${git_sh_location}")" || \
   (echo >&2 "Failed to locate ${git_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/git.sh
 source "${git_sh}"
 
 github_sh_location=cgrindel_bazel_starlib/shlib/lib/github.sh
 github_sh="$(rlocation "${github_sh_location}")" || \
   (echo >&2 "Failed to locate ${github_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/github.sh
 source "${github_sh}"
 
 
@@ -44,24 +48,24 @@ is_installed git || fail "Could not find git." "${required_software}"
 # MARK - Process Args
 
 get_usage() {
-  local utility="$(basename "${BASH_SOURCE[0]}")"
-  echo "$(cat <<-EOF
+  local utility
+  utility="$(basename "${BASH_SOURCE[0]}")"
+  cat <<-EOF
 Create a release tag and push it to the remote.
 
 Usage:
 ${utility} [--remote <remote>] [--branch <branch>] <tag>
 EOF
-  )"
 }
 
 reset_tag=false
+main_branch=main
 
 args=()
 while (("$#")); do
   case "${1}" in
     "--help")
       show_usage
-      exit 0
       ;;
     --remote)
       remote="${2}"
@@ -108,13 +112,12 @@ if git_tag_exists "${tag}"; then
   echo "The tag (${tag}) exists locally, but does not exist on origin."
 else
   commit="$( get_git_commit_hash "${remote}/${main_branch}" )"
-  echo "$(cat <<-EOF
+  cat <<-EOF
 Creating release tag.
 Tag:    ${tag}
 Branch: ${main_branch}
 Commit: ${commit}
 EOF
-)"
   create_git_release_tag "${tag}" "${commit}"
 fi
 

bzlrelease/tools/generate_gh_changelog.sh

@@ -16,21 +16,25 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 fail_sh_location=cgrindel_bazel_starlib/shlib/lib/fail.sh
 fail_sh="$(rlocation "${fail_sh_location}")" || \
   (echo >&2 "Failed to locate ${fail_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/fail.sh
 source "${fail_sh}"
 
 env_sh_location=cgrindel_bazel_starlib/shlib/lib/env.sh
 env_sh="$(rlocation "${env_sh_location}")" || \
   (echo >&2 "Failed to locate ${env_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/env.sh
 source "${env_sh}"
 
 git_sh_location=cgrindel_bazel_starlib/shlib/lib/git.sh
 git_sh="$(rlocation "${git_sh_location}")" || \
   (echo >&2 "Failed to locate ${git_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/git.sh
 source "${git_sh}"
 
 github_sh_location=cgrindel_bazel_starlib/shlib/lib/github.sh
 github_sh="$(rlocation "${github_sh_location}")" || \
   (echo >&2 "Failed to locate ${github_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/github.sh
 source "${github_sh}"
 
 
@@ -42,6 +46,7 @@ is_installed git || fail "Could not find git."
 
 # MARK - Process Arguments
 
+main_branch=main
 args=()
 while (("$#")); do
   case "${1}" in
@@ -65,14 +70,14 @@ tag_name="${args[0]}"
 
 # MARK - Generate the changelog.
 
-starting_dir="${PWD}"
 cd "${BUILD_WORKSPACE_DIRECTORY}"
 
 repo_url="$( get_git_remote_url )"
 is_github_repo_url "${repo_url}" || \
   fail "The git repository's remote URL does not appear to be a Github URL. ${repo_url}"
 
 # Fetch the latest from origin
+# shellcheck disable=SC2119
 fetch_latest_from_git_remote
 
 # Construct the args for generating the changelog.

bzlrelease/tools/generate_git_archive.sh

@@ -23,21 +23,25 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 fail_sh_location=cgrindel_bazel_starlib/shlib/lib/fail.sh
 fail_sh="$(rlocation "${fail_sh_location}")" || \
   (echo >&2 "Failed to locate ${fail_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/fail.sh
 source "${fail_sh}"
 
 env_sh_location=cgrindel_bazel_starlib/shlib/lib/env.sh
 env_sh="$(rlocation "${env_sh_location}")" || \
   (echo >&2 "Failed to locate ${env_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/env.sh
 source "${env_sh}"
 
 git_sh_location=cgrindel_bazel_starlib/shlib/lib/git.sh
 git_sh="$(rlocation "${git_sh_location}")" || \
   (echo >&2 "Failed to locate ${git_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/git.sh
 source "${git_sh}"
 
 github_sh_location=cgrindel_bazel_starlib/shlib/lib/github.sh
 github_sh="$(rlocation "${github_sh_location}")" || \
   (echo >&2 "Failed to locate ${github_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/github.sh
 source "${github_sh}"
 
 is_installed git || fail "This utility requires git to be installed and in the path."
@@ -90,10 +94,10 @@ done
 
 # MARK - Main
 
-starting_dir="${PWD}"
 cd "${BUILD_WORKSPACE_DIRECTORY}"
 
 # Fetch the latest from origin
+# shellcheck disable=SC2119
 fetch_latest_from_git_remote
 
 if [[ -z "${prefix:-}" ]]; then

bzlrelease/tools/generate_module_snippet.sh

@@ -19,6 +19,7 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 fail_sh_location=cgrindel_bazel_starlib/shlib/lib/fail.sh
 fail_sh="$(rlocation "${fail_sh_location}")" || \
   (echo >&2 "Failed to locate ${fail_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/fail.sh
 source "${fail_sh}"
 
 # MARK - Process Args

bzlrelease/tools/generate_release_notes.sh

@@ -16,6 +16,7 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
 fail_sh_location=cgrindel_bazel_starlib/shlib/lib/fail.sh
 fail_sh="$(rlocation "${fail_sh_location}")" || \
   (echo >&2 "Failed to locate ${fail_sh_location}" && exit 1)
+# shellcheck source=SCRIPTDIR/../../shlib/lib/fail.sh
 source "${fail_sh}"
 
 generate_gh_changelog_sh_location=cgrindel_bazel_starlib/bzlrelease/tools/generate_gh_changelog.sh
@@ -61,7 +62,7 @@ while (("$#")); do
   esac
 done
 
-[[ ${#args[@]} == 0 ]] && fail "A tag name for the release must be specified."
+[[ ${#args[@]} -eq 0 ]] && fail "A tag name for the release must be specified."
 tag_name="${args[0]}"
 
 if [[ -z "${generate_workspace_snippet:-}" ]] && [[ -z "${generate_module_snippet:-}" ]]; then