Compare commits

..

No commits in common. "main" and "v0.0.9" have entirely different histories.
main ... v0.0.9

11 changed files with 72 additions and 142 deletions

View file

@ -4,7 +4,6 @@ OUT_DIR = dist
OUTPUT = $(OUT_DIR)/beddu.sh OUTPUT = $(OUT_DIR)/beddu.sh
SRC_DIR = src SRC_DIR = src
DEMO_DIR = demo DEMO_DIR = demo
README = README.md
YEAR = $(shell date +%Y) YEAR = $(shell date +%Y)
IP = $(shell curl -s ipinfo.io/ip) IP = $(shell curl -s ipinfo.io/ip)
@ -30,48 +29,35 @@ demo: build
_release: _release:
@if [ -z "$(filter-out $@,$(MAKECMDGOALS))" ]; then \ @if [ -z "$(filter-out $@,$(MAKECMDGOALS))" ]; then \
echo "❗User Error: Please specify a version number (e.g. make _release v0.0.5)"; \ echo "Error: Please specify a version number (e.g. make release v0.0.5)"; \
exit 1; \ exit 1; \
fi fi
$(eval VERSION := $(filter-out $@,$(MAKECMDGOALS))) $(eval VERSION := $(filter-out $@,$(MAKECMDGOALS)))
@if [ "$$(git branch --show-current)" != "main" ]; then \
echo "❗User Error: Releases can only be made from the main branch"; \
exit 1; \
fi
@if ! git diff-index --quiet HEAD --; then \ @if ! git diff-index --quiet HEAD --; then \
echo "❗User Error: Git working directory is not clean. Please commit or stash your changes first."; \ echo "Error: Git working directory is not clean. Please commit or stash your changes first."; \
exit 1; \ exit 1; \
fi; \ fi; \
$(MAKE) build $(MAKE) build; \
@echo "" sed -i '' "s/# Version: .*/# Version: $(VERSION)/" $(OUTPUT); \
@sed -i '' "s/# Version: .*/# Version: $(VERSION)/" $(OUTPUT); \ git add $(OUTPUT); \
sed -i '' -E "s/v[0-9]+\.[0-9]+\.[0-9]+/$(VERSION)/" $(README)
@git add $(OUTPUT) $(README); \
git commit -m "Release $(VERSION)"; \ git commit -m "Release $(VERSION)"; \
git tag -a "$(VERSION)" -m "Release $(VERSION)" git tag -a "$(VERSION)" -m "Release $(VERSION)"
@echo "" @echo "\nRelease complete: \033[32m$(VERSION)\033[0m"
@git push --follow-tags
@echo ""
@gh release create "$(VERSION)" --generate-notes --title "$(VERSION)" "$(OUTPUT)#beddu.sh"
@echo "\n\033[32m✔\033[0m Release complete: \033[32m$(VERSION)\033[0m"
# Get the last version tag and increment the appropriate part # Get the last version tag and increment the appropriate part
release-patch: release-patch:
@echo ""
@LAST_VERSION=$$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0"); \ @LAST_VERSION=$$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0"); \
NEW_VERSION=$$(echo $$LAST_VERSION | awk -F. '{print $$1"."$$2"."$$3+1}'); \ NEW_VERSION=$$(echo $$LAST_VERSION | awk -F. '{print $$1"."$$2"."$$3+1}'); \
echo "Bumping patch version from $$LAST_VERSION to $$NEW_VERSION"; \ echo "Bumping patch version from $$LAST_VERSION to $$NEW_VERSION"; \
$(MAKE) _release $$NEW_VERSION $(MAKE) _release $$NEW_VERSION
release-minor: release-minor:
@echo ""
@LAST_VERSION=$$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0"); \ @LAST_VERSION=$$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0"); \
NEW_VERSION=$$(echo $$LAST_VERSION | awk -F. '{print $$1"."$$2+1".0"}'); \ NEW_VERSION=$$(echo $$LAST_VERSION | awk -F. '{print $$1"."$$2+1".0"}'); \
echo "Bumping minor version from $$LAST_VERSION to $$NEW_VERSION"; \ echo "Bumping minor version from $$LAST_VERSION to $$NEW_VERSION"; \
$(MAKE) _release $$NEW_VERSION $(MAKE) _release $$NEW_VERSION
release-major: release-major:
@echo ""
@LAST_VERSION=$$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0"); \ @LAST_VERSION=$$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0"); \
NEW_VERSION=$$(echo $$LAST_VERSION | awk -F. '{print "v"$$2+1".0.0"}'); \ NEW_VERSION=$$(echo $$LAST_VERSION | awk -F. '{print "v"$$2+1".0.0"}'); \
echo "Bumping major version from $$LAST_VERSION to $$NEW_VERSION"; \ echo "Bumping major version from $$LAST_VERSION to $$NEW_VERSION"; \
@ -81,7 +67,6 @@ release-major:
@: @:
$(OUTPUT): $(ALL_SRC_FILES) $(OUTPUT): $(ALL_SRC_FILES)
@echo ""
@mkdir -p $(OUT_DIR) @mkdir -p $(OUT_DIR)
@echo '#!/usr/bin/env bash' > $(OUTPUT) @echo '#!/usr/bin/env bash' > $(OUTPUT)
@echo '# shellcheck disable=all' >> $(OUTPUT) @echo '# shellcheck disable=all' >> $(OUTPUT)
@ -98,9 +83,8 @@ $(OUTPUT): $(ALL_SRC_FILES)
grep -v '^\s*#\|^source \|^SCRIPT_DIR=\|^readonly BEDDU_.*_LOADED\|^\[\[ \$$BEDDU_.*_LOADED \]\]' "$$file" | sed '/^[[:space:]]*$$/d' | sed 's/#[a-zA-Z0-9 ]*$$//' >> $(OUTPUT); \ grep -v '^\s*#\|^source \|^SCRIPT_DIR=\|^readonly BEDDU_.*_LOADED\|^\[\[ \$$BEDDU_.*_LOADED \]\]' "$$file" | sed '/^[[:space:]]*$$/d' | sed 's/#[a-zA-Z0-9 ]*$$//' >> $(OUTPUT); \
done done
@chmod +x $(OUTPUT) @chmod +x $(OUTPUT)
@echo "\033[32m✔\033[0m Build complete: \033[32m$(OUTPUT)\033[0m" @echo "\nBuild complete: \033[32m$(OUTPUT)\033[0m"
clean: clean:
@echo ""
@rm -rf $(OUT_DIR) @rm -rf $(OUT_DIR)
@echo "\033[32m✔\033[0m Clean up completed." @echo "\nClean up completed."

View file

@ -1,4 +1,4 @@
# Beddu 💅🏻 # Beddu
A lightweight bash framework for interactive scripts with pretty output. A lightweight bash framework for interactive scripts with pretty output.
@ -22,17 +22,21 @@ And you will easily be able to build things like:
- **Visual Indicators**: Spinners, checkmarks, and error symbols - **Visual Indicators**: Spinners, checkmarks, and error symbols
- **Line Manipulation**: Replace previous output for dynamic updates - **Line Manipulation**: Replace previous output for dynamic updates
## Installation and Usage ## Installation
**Beddu** is meant to be sourced in your own script. Clone the repository or download `beddu.sh` to your project:
1. Download the latest release (currently: **v1.1.0**) of `beddu.sh` to your project:
```bash ```bash
$ curl -O https://raw.githubusercontent.com/mjsarfatti/beddu/refs/tags/v1.1.0/dist/beddu.sh # Clone the repository
git clone https://github.com/mjsarfatti/beddu.git
# Or just download the compiled script
curl -O https://raw.githubusercontent.com/mjsarfatti/beddu/main/beddu.sh
``` ```
2. Source the `beddu.sh` file in your script: ## Usage
Source the `beddu.sh` file in your script:
```bash ```bash
#!/usr/bin/env bash #!/usr/bin/env bash
@ -42,18 +46,9 @@ source "/path/to/beddu.sh"
pen bold blue "Hello, world!" pen bold blue "Hello, world!"
``` ```
## Demo
To see it in action, clone the repository, then run `make demo`. This will run the same interactive demo that you can see in the video above (please note that a 12MB wikimedia.org random file will be downloaded during the demo to showcase the functionality - a prompt will let you delete it at the end):
```bash
$ git clone https://github.com/mjsarfatti/beddu.git
$ make demo
```
## Examples ## Examples
More can be seen by looking at the [demo](./demo/demo.sh) file, but here is a quick overview: More can be seen by looking at the [demo](./beddu.sh) file, but here is a quick overview:
### Text Formatting and Colors ### Text Formatting and Colors
@ -78,15 +73,10 @@ pen "This is $(pen yellow "yellow"), and this is $(pen bold "bold")"
### Interactive Functions ### Interactive Functions
```bash ```bash
# Kindly ask for input (empty answer is accepted) # Ask for input
seek name "What's your name?" ask name "What's your name?"
pen "Hello, $name!" pen "Hello, $name!"
# Firmly ask for input (empty answer NOT accepted)
request name "No really, what's your name?"
pen "There you go, $name!"
# Yes/no confirmation (defaults to "yes") # Yes/no confirmation (defaults to "yes")
if confirm "Continue?"; then if confirm "Continue?"; then
pen green "Continuing..." pen green "Continuing..."
@ -124,6 +114,14 @@ sleep 1
check "Task completed!" # We can directly `check`, `warn`, or `throw` after a `spin` call - the message will always replace the spin line check "Task completed!" # We can directly `check`, `warn`, or `throw` after a `spin` call - the message will always replace the spin line
``` ```
## Demo
To see it in action paste the following command in your terminal:
```bash
curl -s https://raw.githubusercontent.com/mjsarfatti/beddu/main/demo/demo.sh | bash
```
## Function Reference ## Function Reference
### Text Formatting ### Text Formatting
@ -136,8 +134,7 @@ check "Task completed!" # We can directly `check`, `warn`, or `throw` after a `s
### User Interaction ### User Interaction
- `seek [retval] PROMPT` - Get (optional) text input from user, saves the answer in `$retval` - `ask [retval] PROMPT` - Get text input from user, saves the answer in `$retval`
- `request [retval] PROMPT` - Like above, but doesn't accept an empty response, saves the answer in `$retval`
- `confirm [OPTIONS] PROMPT` - Get yes/no input - `confirm [OPTIONS] PROMPT` - Get yes/no input
- `--default-yes` - Set default answer to "yes" (default behavior) - `--default-yes` - Set default answer to "yes" (default behavior)
- `--default-no` - Set default answer to "no" - `--default-no` - Set default answer to "no"

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 185 KiB

After

Width:  |  Height:  |  Size: 210 KiB

Before After
Before After

View file

@ -2,17 +2,20 @@
. beddu.sh . beddu.sh
pen purple "Hello, I'm your IP helper, here for all your IP needs!" line
pen purple "Hello, I'm your IP helper, here to help you will all your IP needs."
line
choose ACTION "What would you like to do?" "Get my IP" "Get my location" choose action "What would you like to do?" "Get my IP" "Get my location"
case "$ACTION" in case "$action" in
"Get my IP") "Get my IP")
run --out IP curl ipinfo.io/ip run --out ip curl ipinfo.io/ip
pen "Your IP is $IP" line; pen "Your IP is $ip"
;; ;;
"Get my LOCATION") "Get my location")
run --out LOCATION curl -s ipinfo.io/loc run --out location curl -s ipinfo.io/loc
pen "Your coordinates are $LOCATION" line; pen "Your coordinates are $location"
;; ;;
esac esac

View file

@ -102,7 +102,7 @@ demo() {
pen $_pink italic "-- Interactive functions --" pen $_pink italic "-- Interactive functions --"
line line
request name "How can I call you?" ask name "How can I call you?"
pen "Hello, $(pen bold cyan "${name:?}")" pen "Hello, $(pen bold cyan "${name:?}")"
line line

62
dist/beddu.sh vendored
View file

@ -2,7 +2,7 @@
# shellcheck disable=all # shellcheck disable=all
# #
# beddu.sh - A lightweight bash framework for interactive scripts and pretty output # beddu.sh - A lightweight bash framework for interactive scripts and pretty output
# Version: v1.1.0 # Version: v0.0.9
# #
# Copyright © 2025 Manuele Sarfatti # Copyright © 2025 Manuele Sarfatti
# Licensed under the MIT license # Licensed under the MIT license
@ -190,6 +190,29 @@ warn() {
pen italic "$@" pen italic "$@"
} }
ask() {
local -n outvar="$1"
local prompt
local answer
prompt=$(
pen -n blue "${_q:-?} "
pen "${2}"
pen -n blue "${_a:-} "
)
show_cursor
while true; do
read -r -p "$prompt" answer
case "$answer" in
"")
echo
warn "Please type your answer."
;;
*) break ;;
esac
done
outvar="$answer"
}
choose() { choose() {
local -n outvar="$1" local -n outvar="$1"
local prompt local prompt
@ -286,40 +309,3 @@ confirm() {
esac esac
done done
} }
request() {
local -n outvar="$1"
local prompt
local answer
prompt=$(
pen -n blue "${_q:-?} "
pen "${2}"
pen -n blue "${_a:-} "
)
show_cursor
while true; do
read -r -p "$prompt" answer
case "$answer" in
"")
echo
warn "Please type your answer."
;;
*) break ;;
esac
done
outvar="$answer"
}
seek() {
local -n outvar="$1"
local prompt
local answer
prompt=$(
pen -n blue "${_q:-?} "
pen "${2}"
pen -n blue "${_a:-} "
)
show_cursor
read -r -p "$prompt" answer
outvar="$answer"
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 231 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 265 KiB

View file

@ -1,6 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# shellcheck disable=SC1091 # shellcheck disable=SC1091
# request.sh - Get required text input from the user # ask.sh - Get free text input from the user
[[ $BEDDU_ASK_LOADED ]] && return [[ $BEDDU_ASK_LOADED ]] && return
readonly BEDDU_ASK_LOADED=true readonly BEDDU_ASK_LOADED=true
@ -11,14 +11,14 @@ source "$SCRIPT_DIR/../00.utils/movements.sh"
source "$SCRIPT_DIR/../01.core/pen.sh" source "$SCRIPT_DIR/../01.core/pen.sh"
source "$SCRIPT_DIR/../02.ui/warn.sh" source "$SCRIPT_DIR/../02.ui/warn.sh"
# Ask a question and require a free text answer from the user # Ask a question and get a free text answer from the user
# #
# Usage: # Usage:
# request outvar text # ask outvar text
# Example: # Example:
# request name "What is your name?" # ask name "What is your name?"
# echo "Hello, $name!" # echo "Hello, $name!"
request() { ask() {
local -n outvar="$1" # Declare nameref local -n outvar="$1" # Declare nameref
local prompt local prompt
local answer local answer

View file

@ -1,40 +0,0 @@
#!/usr/bin/env bash
# shellcheck disable=SC1091
# seek.sh - Get free text input from the user
[[ $BEDDU_ASK_LOADED ]] && return
readonly BEDDU_ASK_LOADED=true
SCRIPT_DIR="$(dirname -- "${BASH_SOURCE[0]}")"
source "$SCRIPT_DIR/../00.utils/_symbols.sh"
source "$SCRIPT_DIR/../00.utils/movements.sh"
source "$SCRIPT_DIR/../01.core/pen.sh"
source "$SCRIPT_DIR/../02.ui/warn.sh"
# Ask a question and get a free text answer from the user
#
# Usage:
# seek outvar text
# Example:
# seek name "What is your name?"
# echo "Hello, $name!"
seek() {
local -n outvar="$1" # Declare nameref
local prompt
local answer
# Set prompt with default indicator
prompt=$(
pen -n blue "${_q:-?} "
pen "${2}"
pen -n blue "${_a:-} "
)
show_cursor
# Get response
read -r -p "$prompt" answer
# shellcheck disable=SC2034
outvar="$answer"
}