From 4a0de6e2b8f11563ae2dff726aaa43234b0414b9 Mon Sep 17 00:00:00 2001 From: Robert Stoll Date: Fri, 18 Aug 2023 13:38:57 +0200 Subject: [PATCH] improve formatting, move reason for shellcheck disable on same line --- README.md | 56 ++++++++++++++++----------------- src/utility/update-bash-docu.sh | 2 +- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 7abd6e7a..a39f53dd 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ We recommend you use the following code at the beginning of your script in case - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -139,7 +139,7 @@ Following an example: - + ```bash # run the install-shellcheck.sh in your github/gitlab workflow # for instance, assuming you fetched this file via gt and remote name is tegonal-scripts @@ -160,7 +160,7 @@ jobs: - + ```bash # run the install-shellcheck.sh in your github/gitlab workflow # for instance, assuming you fetched this file via gt and remote name is tegonal-scripts @@ -186,7 +186,7 @@ Helper function which performs a signin and redeploycontainers - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -254,7 +254,7 @@ The most important functions are defined in this file: jelastic_signin which in - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -293,7 +293,7 @@ settings for shellcheck. - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -371,7 +371,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -430,7 +430,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -489,7 +489,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -562,7 +562,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -617,7 +617,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -701,7 +701,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -750,7 +750,7 @@ Utility functions when dealing with arrays. - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -798,7 +798,7 @@ Utility functions to interact with the user. - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -822,7 +822,7 @@ Utility functions which check some conditions like is passed arg the correct typ - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -882,7 +882,7 @@ Utility functions around git. - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -941,7 +941,7 @@ Utility functions which hopefully make it easier for you to deal with gpg - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -971,7 +971,7 @@ trustGpgKey ~/.gpg info.com - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -992,7 +992,7 @@ wgetAndVerify "https://github.com/tegonal/gt/.gt/signing-key.public.asc" - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1029,7 +1029,7 @@ Utility functions to log messages including a severity level where logError writ - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1114,7 +1114,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1166,7 +1166,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1212,7 +1212,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1254,7 +1254,7 @@ Utility functions when parsing (see also [Parse arguments](#parse-arguments)). - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1287,7 +1287,7 @@ Utility function to find out the initial `declare` statement after following `de - + ```bash #!/usr/bin/env bash # shellcheck disable=SC2034 @@ -1329,7 +1329,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1373,7 +1373,7 @@ Establishes a guard by creating a variable based on the file which shall be sour - + ```bash #!/usr/bin/env bash set -euo pipefail @@ -1416,7 +1416,7 @@ Full usage example: - + ```bash #!/usr/bin/env bash set -euo pipefail diff --git a/src/utility/update-bash-docu.sh b/src/utility/update-bash-docu.sh index a9487f66..c6324b24 100644 --- a/src/utility/update-bash-docu.sh +++ b/src/utility/update-bash-docu.sh @@ -66,5 +66,5 @@ function updateBashDocumentation() { -pe "s/(###+\s+Usage\s+###+\n#\n)[\S\s]+?(\n#\n###+)/\$1${quotedSnippet}\$2/g;" \ "$script" || die "could not replace the Usage section for %s" "$script" - replaceSnippet "$script" "$id" "$dir" "$pattern" "$markdownSnippet" + replaceSnippet "$script.doc" "$id" "$dir" "$pattern" "$markdownSnippet" }