From 372cab123b4d510fc6404aa9702dfd9199e236b9 Mon Sep 17 00:00:00 2001
From: Edwin Kofler <edwin@kofler.dev>
Date: Wed, 11 Oct 2023 01:15:50 -0700
Subject: [PATCH] fix: Use `#!/usr/bin/env bash` shebang

---
 README.md                                                 | 8 ++++----
 examples/readme-example.sh                                | 2 +-
 tests/run_tests                                           | 2 +-
 tests/testcases/@function-declaration.test.sh             | 2 +-
 tests/testcases/@name-and-@description.test.sh            | 2 +-
 tests/testcases/@option.test.sh                           | 2 +-
 tests/testcases/@see.test.sh                              | 2 +-
 tests/testcases/@set.test.sh                              | 2 +-
 tests/testcases/@stderr.test.sh                           | 2 +-
 tests/testcases/@stdin.test.sh                            | 2 +-
 tests/testcases/@stdout.test.sh                           | 2 +-
 tests/testcases/function-in-@example.test.sh              | 2 +-
 tests/testcases/function-tags.test.sh                     | 2 +-
 tests/testcases/global-tags.test.sh                       | 4 ++--
 .../issue-12-no-space-in-function-declaration.test.sh     | 4 ++--
 .../issue-25-missing-trailing-newline-in-see-also.test.sh | 4 ++--
 .../issue-4-whitespace-in-function-declaration.test.sh    | 4 ++--
 ...e-56-function-opening-bracket-on-separate-line.test.sh | 2 +-
 tests/testcases/numbered-arguments.test.sh                | 2 +-
 tests/testcases/table-of-contents.test.sh                 | 2 +-
 20 files changed, 27 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index 5b9bc48..4c331a0 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ $ shdoc < lib.sh > doc.md
 _Source_ [examples/readme-example.sh](examples/readme-example.sh)<br />
 _Output_: [examples/readme-example.md](examples/readme-example.md)<br/><br/>
 ~~~bash
-#!/bin/bash
+#!/usr/bin/env bash
 # @file libexample
 # @brief A library that solves some common problems.
 # @description
@@ -153,7 +153,7 @@ file.
 **Example**
 
 ```bash
-#!/bin/bash
+#!/usr/bin/env bash
 # @name MyLibrary
 ```
 
@@ -167,7 +167,7 @@ A brief line about the project. Can be specified once in the beginning of the fi
 
 **Example**
 ```bash
-#!/bin/bash
+#!/usr/bin/env bash
 # @brief A library to solve a few problems.
 ```
 
@@ -180,7 +180,7 @@ A multiline description of the project/section/function.
 
 **Example**
 ```bash
-#!/bin/bash
+#!/usr/bin/env bash
 # @description A long description of the library.
 # Second line of the project description.
 
diff --git a/examples/readme-example.sh b/examples/readme-example.sh
index f5a3bab..c8010eb 100644
--- a/examples/readme-example.sh
+++ b/examples/readme-example.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # @file libexample
 # @brief A library that solves some common problems.
 # @description
diff --git a/tests/run_tests b/tests/run_tests
index 1b14866..aa54c6c 100755
--- a/tests/run_tests
+++ b/tests/run_tests
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -euo pipefail
 
diff --git a/tests/testcases/@function-declaration.test.sh b/tests/testcases/@function-declaration.test.sh
index 201f33a..fa8cd16 100644
--- a/tests/testcases/@function-declaration.test.sh
+++ b/tests/testcases/@function-declaration.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
 # @name Project Name
diff --git a/tests/testcases/@name-and-@description.test.sh b/tests/testcases/@name-and-@description.test.sh
index 71925f9..3ae229c 100644
--- a/tests/testcases/@name-and-@description.test.sh
+++ b/tests/testcases/@name-and-@description.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
 # @name Project Name
diff --git a/tests/testcases/@option.test.sh b/tests/testcases/@option.test.sh
index 386852e..b2c7d89 100644
--- a/tests/testcases/@option.test.sh
+++ b/tests/testcases/@option.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # @file test/testcases/@optional-arguments.test.sh
 # @author Pierre-Yves Landuré < contact at biapy dot fr >
 # @brief Test cases for @option keyword with options.
diff --git a/tests/testcases/@see.test.sh b/tests/testcases/@see.test.sh
index 6708f0d..b9b4902 100644
--- a/tests/testcases/@see.test.sh
+++ b/tests/testcases/@see.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # @file test/testcases/@see.test.sh
 # @author Pierre-Yves Landuré < contact at biapy dot fr >
 # @brief Test cases for @see keyword.
diff --git a/tests/testcases/@set.test.sh b/tests/testcases/@set.test.sh
index f313d1a..eedc331 100644
--- a/tests/testcases/@set.test.sh
+++ b/tests/testcases/@set.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
 # @name Project Name
diff --git a/tests/testcases/@stderr.test.sh b/tests/testcases/@stderr.test.sh
index e341ab2..8934a77 100644
--- a/tests/testcases/@stderr.test.sh
+++ b/tests/testcases/@stderr.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # @file test/testcases/@stderr.test.sh
 # @author Pierre-Yves Landuré < contact at biapy dot fr >
 # @brief Test cases for @stderr keyword.
diff --git a/tests/testcases/@stdin.test.sh b/tests/testcases/@stdin.test.sh
index 0593eed..0d42a28 100644
--- a/tests/testcases/@stdin.test.sh
+++ b/tests/testcases/@stdin.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # @file test/testcases/@stdin.test.sh
 # @author Pierre-Yves Landuré < contact at biapy dot fr >
 # @brief Test cases for @stdin keyword.
diff --git a/tests/testcases/@stdout.test.sh b/tests/testcases/@stdout.test.sh
index ccc5ec2..ec64076 100644
--- a/tests/testcases/@stdout.test.sh
+++ b/tests/testcases/@stdout.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # @file test/testcases/@stdout.test.sh
 # @author Pierre-Yves Landuré < contact at biapy dot fr >
 # @brief Test cases for @stdout keyword.
diff --git a/tests/testcases/function-in-@example.test.sh b/tests/testcases/function-in-@example.test.sh
index fe77290..967272f 100644
--- a/tests/testcases/function-in-@example.test.sh
+++ b/tests/testcases/function-in-@example.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
 # @description Same, as \`tests:eval\`, but writes stdout into given variable and
diff --git a/tests/testcases/function-tags.test.sh b/tests/testcases/function-tags.test.sh
index 062a99f..abc3826 100644
--- a/tests/testcases/function-tags.test.sh
+++ b/tests/testcases/function-tags.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
 # @description Multiline description goes here and
diff --git a/tests/testcases/global-tags.test.sh b/tests/testcases/global-tags.test.sh
index e9e1763..975cb32 100644
--- a/tests/testcases/global-tags.test.sh
+++ b/tests/testcases/global-tags.test.sh
@@ -1,7 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
-#!/bin/bash
+#!/usr/bin/env bash
 #
 # @file Title of file script
 # @brief Small description of the script.
diff --git a/tests/testcases/issue-12-no-space-in-function-declaration.test.sh b/tests/testcases/issue-12-no-space-in-function-declaration.test.sh
index ab44dfb..0a5a0ec 100644
--- a/tests/testcases/issue-12-no-space-in-function-declaration.test.sh
+++ b/tests/testcases/issue-12-no-space-in-function-declaration.test.sh
@@ -1,7 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
-#!/bin/bash
+#!/usr/bin/env bash
 
 # @description a desc for fn1
 fn1() {
diff --git a/tests/testcases/issue-25-missing-trailing-newline-in-see-also.test.sh b/tests/testcases/issue-25-missing-trailing-newline-in-see-also.test.sh
index 05c821d..6cae84a 100644
--- a/tests/testcases/issue-25-missing-trailing-newline-in-see-also.test.sh
+++ b/tests/testcases/issue-25-missing-trailing-newline-in-see-also.test.sh
@@ -1,7 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
-#!/bin/bash
+#!/usr/bin/env bash
 
 # @description a desc for fn1
 # @see fn2()
diff --git a/tests/testcases/issue-4-whitespace-in-function-declaration.test.sh b/tests/testcases/issue-4-whitespace-in-function-declaration.test.sh
index fd522cd..8358d3b 100644
--- a/tests/testcases/issue-4-whitespace-in-function-declaration.test.sh
+++ b/tests/testcases/issue-4-whitespace-in-function-declaration.test.sh
@@ -1,7 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
-#!/bin/bash
+#!/usr/bin/env bash
 
 # @arg \$1 string fn var.
 # @stdout result of fn
diff --git a/tests/testcases/issue-56-function-opening-bracket-on-separate-line.test.sh b/tests/testcases/issue-56-function-opening-bracket-on-separate-line.test.sh
index 8ffbb5c..6613522 100644
--- a/tests/testcases/issue-56-function-opening-bracket-on-separate-line.test.sh
+++ b/tests/testcases/issue-56-function-opening-bracket-on-separate-line.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
 #!/sbin/sh
diff --git a/tests/testcases/numbered-arguments.test.sh b/tests/testcases/numbered-arguments.test.sh
index 15fdb8e..b9132bd 100644
--- a/tests/testcases/numbered-arguments.test.sh
+++ b/tests/testcases/numbered-arguments.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # @file test/testcases/@numbered-arguments.test.sh
 # @author Pierre-Yves Landuré < contact at biapy dot fr >
 # @brief Test cases for @arg keyword.
diff --git a/tests/testcases/table-of-contents.test.sh b/tests/testcases/table-of-contents.test.sh
index b4e0180..f31af12 100644
--- a/tests/testcases/table-of-contents.test.sh
+++ b/tests/testcases/table-of-contents.test.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 tests:put input <<EOF
 # @description example function 1