Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename checkIfPathNamedIsOutsideOf to checkPathNamedIsInsideOf #217

Merged
merged 1 commit into from
Oct 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1420,7 +1420,7 @@ echo "myVar4 $myVar4"

declare currentDir
currentDir=$(pwd)
checkIfPathNamedIsOutsideOf "$myVar4" "source directory" "$currentDir" # same as exitIfArgIsNotVersion if set -e has an effect on this line
checkPathNamedIsInsideOf "$myVar4" "source directory" "$currentDir" # same as exitIfPathNamedIsOutsideOf if set -e has an effect on this line
exitIfPathNamedIsOutsideOf "$myVar4/plugins.txt" "plugins" "$currentDir"
```

Expand Down
2 changes: 1 addition & 1 deletion src/utility/checks.doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ echo "myVar4 $myVar4"

declare currentDir
currentDir=$(pwd)
checkIfPathNamedIsOutsideOf "$myVar4" "source directory" "$currentDir" # same as exitIfPathNamedIsOutsideOf if set -e has an effect on this line
checkPathNamedIsInsideOf "$myVar4" "source directory" "$currentDir" # same as exitIfPathNamedIsOutsideOf if set -e has an effect on this line
exitIfPathNamedIsOutsideOf "$myVar4/plugins.txt" "plugins" "$currentDir"
10 changes: 5 additions & 5 deletions src/utility/checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
#
# declare currentDir
# currentDir=$(pwd)
# checkIfPathNamedIsOutsideOf "$myVar4" "source directory" "$currentDir" # same as exitIfArgIsNotVersion if set -e has an effect on this line
# checkPathNamedIsInsideOf "$myVar4" "source directory" "$currentDir" # same as exitIfPathNamedIsOutsideOf if set -e has an effect on this line
# exitIfPathNamedIsOutsideOf "$myVar4/plugins.txt" "plugins" "$currentDir"
#
###################################
Expand Down Expand Up @@ -316,21 +316,21 @@ function exitIfVariablesNotDeclared() {
done
}

function checkIfPathNamedIsOutsideOf() {
function checkPathNamedIsInsideOf() {
local path name parentDirectory
# shellcheck disable=SC2034 # is passed by name to parseFnArgs
local -ra params=(path name parentDirectory)
parseFnArgs params "$@"

local pathAbsolute parentDirectoryAbsolute
pathAbsolute="$(realpath "$path")"
parentDirectoryAbsolute="$(realpath "$parentDirectory")"
pathAbsolute="$(realpath -m "$path")"
parentDirectoryAbsolute="$(realpath -m "$parentDirectory")"
if ! [[ "$pathAbsolute" == "$parentDirectoryAbsolute"* ]]; then
returnDying "the given \033[0;36m%s\033[0m %s is outside of %s" "$name" "$pathAbsolute" "$parentDirectory" || return $?
fi
}

function exitIfPathNamedIsOutsideOf() {
# shellcheck disable=SC2310 # we are aware of that || will disable set -e for checkIfPathNamedIsOutsideOf
checkIfPathNamedIsOutsideOf "$@" || exit $?
checkPathNamedIsInsideOf "$@" || exit $?
}