Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
aee45ba2ee | |||
ae6becb2cc | |||
8ea89b837b | |||
e37233009c | |||
6399a20ed1 |
@ -4,6 +4,12 @@
|
||||
|
||||
zrep is a powerful and user-friendly package manager for the Zsh shell. It allows you to easily install, manage, and share Zsh packages, such as plugins, themes, and scripts, directly from a central repository.
|
||||
|
||||
## What is it?
|
||||
|
||||
`zrep` in and of itself is the command line tool that you use to install and manage scripts that are placed in `$fpath` used by Zsh. The packages are available on [the zrep website](https://zrep.kekepower.com) where you can, if you want to share your own scripts, register for an account. By sharing your scripts with the community, you are probably making somebody's day easier.
|
||||
|
||||
You can read more in the Wiki.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Easy Installation**: zrep simplifies the process of installing Zsh packages. With a single command, you can install packages from the zrep repository.
|
||||
@ -20,6 +26,8 @@ zrep is a powerful and user-friendly package manager for the Zsh shell. It allow
|
||||
|
||||
To start using zrep, simply run the `zrep init` command to initialize the tool. zrep will guide you through the setup process and create the required configuration files.
|
||||
|
||||
Use the search function on **[the zrep website](https://zrep.kekepower.com)** to find useful scripts until a search function is added to the `zrep` script some time in the future.
|
||||
|
||||
Once initialized, you can explore and install packages using commands like `zrep install <author/package>`, `zrep list`, and `zrep enable <author/package>`.
|
||||
|
||||
## Contributing
|
||||
|
196
zrep → zpi
196
zrep → zpi
@ -2,13 +2,17 @@
|
||||
|
||||
setopt extendedglob
|
||||
|
||||
VERSION="0.0.5" # Tue-2024-04-02
|
||||
VERSION="0.0.8" # Fri-2024-04-05
|
||||
ZREP="Zsh Repository Tool"
|
||||
# Define the default path to .zreprc
|
||||
ZREP_CONFIG="${HOME}/.zreprc"
|
||||
|
||||
function zrep_fpath() {
|
||||
local base_dir="${1}"
|
||||
local mode="${2:-generic}" # Default mode is 'generic'
|
||||
|
||||
# Ensure globbing finds dotfiles and nullglob avoids empty directory issues
|
||||
setopt local_options dotglob nullglob
|
||||
|
||||
# Check if the base directory exists
|
||||
if [[ ! -d "${base_dir}" ]]; then
|
||||
@ -16,12 +20,28 @@ function zrep_fpath() {
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Add directories containing at least one file to fpath
|
||||
for dir in ${base_dir}/**/*(/N); do
|
||||
if [[ -n $(ls -A "${dir}/") ]]; then
|
||||
fpath=(${dir} $fpath)
|
||||
fi
|
||||
done
|
||||
if [[ "${mode}" == "zrep_load" ]]; then
|
||||
# Specific mode for first_letter/author/script structure
|
||||
for one_char_dir in ${base_dir}/?; do
|
||||
[[ -d "${one_char_dir}" ]] || continue
|
||||
|
||||
for script_dir in ${one_char_dir}/*/*(/); do
|
||||
local script_name=$(basename "${script_dir}")
|
||||
local matching_files=("${script_dir}/${script_name}".*)
|
||||
|
||||
if (( ${#matching_files} )); then
|
||||
fpath+=("${script_dir}")
|
||||
fi
|
||||
done
|
||||
done
|
||||
else
|
||||
# Generic mode for any directory containing at least one file
|
||||
for dir in ${base_dir}/**/*(/N); do
|
||||
if [[ -n $(ls -A "${dir}/") ]]; then
|
||||
fpath+=("${dir}")
|
||||
fi
|
||||
done
|
||||
fi
|
||||
}
|
||||
|
||||
if [[ ${1} != "init" ]]; then
|
||||
@ -115,6 +135,65 @@ function zrep_msg() {
|
||||
printf "%b\n" "${color}${message}${base_colors[end]}"
|
||||
}
|
||||
|
||||
#################################################################################################
|
||||
# Function to URL-encode strings in Zsh
|
||||
zrep_search_url_encode() {
|
||||
local string="${1}"
|
||||
local strlen=${#string}
|
||||
local encoded=""
|
||||
|
||||
for (( pos=0 ; pos<strlen ; pos++ )); do
|
||||
c=${string:$pos:1}
|
||||
case "$c" in
|
||||
[-_.~a-zA-Z0-9] ) o="${c}" ;;
|
||||
* ) printf -v o '%%%02x' "'$c"
|
||||
esac
|
||||
encoded+="${o}"
|
||||
done
|
||||
|
||||
echo "${encoded}"
|
||||
# This will output the URL-encoded string
|
||||
}
|
||||
|
||||
# Function to perform a search query and process JSON response
|
||||
zrep_search() {
|
||||
local searchTerm="${@}"
|
||||
|
||||
local encodedSearch=$(zrep_search_url_encode "${searchTerm}")
|
||||
|
||||
# Use the global_repo_url from the config associative array
|
||||
local response=$(curl -s -A "zrep ${VERSION} (curl)" "${config[global_repo_url]}/find.php?s=${encodedSearch}")
|
||||
|
||||
# Determine if the JSON response is an object indicating "No scripts found"
|
||||
local jsonType=$(echo "$response" | jq -r 'type')
|
||||
|
||||
zrep_msg std "\nSearch results:"
|
||||
if [[ "$jsonType" == "object" ]]; then
|
||||
# Assuming an object type indicates a message field exists
|
||||
local message=$(echo "$response" | jq -r '.message')
|
||||
echo "$message"
|
||||
return 0
|
||||
elif [[ "$jsonType" == "array" ]]; then
|
||||
# It's an array, process each item
|
||||
echo "$response" | jq -c '.[]' | while IFS= read -r line; do
|
||||
local script=$(echo "$line" | jq -r '.script')
|
||||
local description=$(echo "$line" | jq -r '.description')
|
||||
local url=$(echo "$line" | jq -r '.url')
|
||||
|
||||
# You can process these variables further as needed
|
||||
zrep_msg other " * $script"
|
||||
zrep_msg sub " - Description: $description"
|
||||
zrep_msg sub " - $url"
|
||||
# echo "-------------------------------------"
|
||||
done
|
||||
else
|
||||
echo "Unexpected JSON format."
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
############################################################################################
|
||||
|
||||
# Function to check if a given string exists in ~/.zshrc
|
||||
function zrep_find_string() {
|
||||
local searchString="$1"
|
||||
@ -174,7 +253,7 @@ function zrep_init() {
|
||||
zrep_install_dir = ${install_dir}
|
||||
|
||||
[global]
|
||||
repo_url = https://kekepower.com/zrep
|
||||
repo_url = https://zrep.kekepower.com
|
||||
theme = classic
|
||||
downloader = ${downloader}
|
||||
EOF
|
||||
@ -232,6 +311,8 @@ EOF
|
||||
zrep_global_downloader https://git.kekepower.com/kekePower/zrep/raw/branch/main/themes/classic -o ${install_dir}/themes/classic
|
||||
fi
|
||||
echo "zrep initialization complete."
|
||||
echo "You should copy 'zrep' to a path in you 'PATH' so that it's accessible."
|
||||
echo "For example '${HOME}/bin'"
|
||||
echo "Remember to 'source ${zshrc_file}' to load the 'zrep' settings."
|
||||
}
|
||||
|
||||
@ -262,17 +343,15 @@ function zrep_parse_remote() {
|
||||
json_data=$(zrep_global_downloader "${url}")
|
||||
|
||||
# Directly extract the details based on author_name and script_name
|
||||
dlurl=$(echo "${json_data}" | jq -r --arg author_name "$author_name" --arg script_name "$script_name" '.authors[] | select(.name==$author_name) | .scripts[] | select(.name==$script_name) | .dlurl')
|
||||
version=$(echo "${json_data}" | jq -r --arg author_name "$author_name" --arg script_name "$script_name" '.authors[] | select(.name==$author_name) | .scripts[] | select(.name==$script_name) | .version')
|
||||
|
||||
# Check if the dlurl and version are found
|
||||
if [[ -n "$dlurl" && -n "$version" ]]; then
|
||||
if [[ -n "$version" ]]; then
|
||||
# Set the details as global
|
||||
export author="$author_name"
|
||||
export script="$script_name"
|
||||
#export author="$author_name"
|
||||
#export script="$script_name"
|
||||
export version
|
||||
export dlurl
|
||||
|
||||
#export dlurl
|
||||
else
|
||||
zrep_msg debug "\nPackage ${package} not found.\n"
|
||||
exit 1
|
||||
@ -354,40 +433,19 @@ function zrep_list_package() {
|
||||
fi
|
||||
}
|
||||
|
||||
# Function to load configuration
|
||||
function zrep_load_config() {
|
||||
|
||||
# Check if jq is available
|
||||
if ! command -v jq &> /dev/null; then
|
||||
if [[ ! -x $(which jq) ]]; then
|
||||
echo "Error: 'jq' is not installed. Please install jq to continue."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ -f "${ZREP_CONFIG}" ]]; then
|
||||
zini "${ZREP_CONFIG}"
|
||||
zrep_fpath ${config[main_zrep_install_dir]}
|
||||
zrep_fpath ${config[main_zrep_install_dir]} zrep_load
|
||||
else
|
||||
if [[ "${1}" == "init" ]]; then
|
||||
echo "\nWelcome to zrep. Looks like this is the first time you are"
|
||||
echo "running me."
|
||||
read "response?Are you ready to set up zrep? (y/n): "
|
||||
if [[ "${response}" =~ ^[Yy]$ ]]; then
|
||||
zrep_init
|
||||
else
|
||||
echo "Setup aborted. Try again later."
|
||||
fi
|
||||
else
|
||||
# echo "${ZREP_CONFIG} not found."
|
||||
# Ask the user if they want to run 'zrep init'
|
||||
echo "\nWelcome to zrep. I was unable to find the config file."
|
||||
read "response?Would you like to run 'zrep init' to set up? (y/n): "
|
||||
if [[ "${response}" =~ ^[Yy]$ ]]; then
|
||||
zrep_init
|
||||
else
|
||||
echo "Initialization canceled. Please run 'zrep init' manually to set up."
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
echo "${ZREP_CONFIG} not found. Run 'zrep init' to set up."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
}
|
||||
@ -412,10 +470,11 @@ function zrep_remove_package() {
|
||||
local first_letter="${author:0:1:l}"
|
||||
local package_dir="${config[main_zrep_install_dir]}/${first_letter}/${author}/${script}"
|
||||
|
||||
zrep_msg info "\nFound installed package: $package_name, version: $installed_version"
|
||||
zrep_msg std "\nFound installed package: $package_name, version: $installed_version"
|
||||
|
||||
# Ask user for confirmation with default response "Y"
|
||||
read "REPLY?Are you sure you want to remove this package? (y/n) [Y]: "
|
||||
zrep_msg info "Are you sure you want to remove this package? (y/n) [Y]: \c"
|
||||
read REPLY
|
||||
REPLY=${REPLY:-Y}
|
||||
echo
|
||||
|
||||
@ -423,7 +482,6 @@ function zrep_remove_package() {
|
||||
# Remove the package directory from disk
|
||||
if [[ -d "${package_dir}" ]]; then
|
||||
rm -rf "${package_dir}"
|
||||
zrep_msg sub "Package directory '${package_dir}' removed successfully."
|
||||
else
|
||||
zrep_msg debug "Warning: Package directory '${package_dir}' not found."
|
||||
fi
|
||||
@ -434,7 +492,7 @@ function zrep_remove_package() {
|
||||
if .[$author] == [] then del(.[$author]) else . end' \
|
||||
"$installed_json" > "$installed_json.tmp" && mv "$installed_json.tmp" "$installed_json"
|
||||
|
||||
zrep_msg sub "Package '${package_name}' removed successfully from installed.json."
|
||||
zrep_msg sub "Package '${package_name}' successfully removed."
|
||||
else
|
||||
zrep_msg info "Removal canceled."
|
||||
fi
|
||||
@ -456,10 +514,8 @@ function zrep_check_if_installed() {
|
||||
|
||||
if [[ -n "${installed_version}" && "${installed_version}" != "null" ]]; then
|
||||
# Package is installed, and version is stored in installed_version
|
||||
# echo "Package $package is installed with version $installed_version."
|
||||
return 0 # Package is installed
|
||||
else
|
||||
# echo "Package $package is not installed."
|
||||
return 1 # Package is not installed
|
||||
fi
|
||||
}
|
||||
@ -480,13 +536,27 @@ function zrep_global_downloader() {
|
||||
exit
|
||||
;;
|
||||
esac
|
||||
|
||||
eval ${dloader} "${1}"
|
||||
}
|
||||
|
||||
function zrep_process_updates() {
|
||||
for package in ${(k)updatesAvailable}; do
|
||||
local updateDetails=(${(s/|/)updatesAvailable[${package}]})
|
||||
local author=${updateDetails[1]}
|
||||
local script=${updateDetails[2]}
|
||||
local version=${updateDetails[3]}
|
||||
echo "Updating ${author}/${script} to version ${version}..."
|
||||
zrep_install_package u "${author}/${script}" "${version}"
|
||||
done
|
||||
}
|
||||
|
||||
typeset -A updatesAvailable
|
||||
function zrep_check_for_updates() {
|
||||
|
||||
local remoteFile="${config[global_repo_url]}/packages.json\?$(date +%s)"
|
||||
# Now using a zrep API to fetch the JSON for checking for updates. This _may_ change in the
|
||||
# future if the load on the DB gets too high.
|
||||
local remoteFile="${config[global_repo_url]}/getver.php"
|
||||
# local localFile="${config[main_zrep_install_dir]}/installed.json"
|
||||
zrep_installed_json
|
||||
local remotePackages=$(zrep_global_downloader "${remoteFile}")
|
||||
@ -508,7 +578,9 @@ function zrep_check_for_updates() {
|
||||
'.authors[] | select(.name==$author) | .scripts[] | select(.name==$script) | .version' <<<"$remotePackages")
|
||||
|
||||
if [[ "${remote_version}" > "${installed_version}" ]]; then
|
||||
updatesAvailable[${author}/${script}]="${remote_version}"
|
||||
# updatesAvailable[${author}/${script}]="${remote_version}"
|
||||
# Store author, script, and version in a single string, separated by "|"
|
||||
updatesAvailable[${author}/${script}]="${author}|${script}|${remote_version}"
|
||||
zrep_msg info "\n${author}/${script} can be updated from ${installed_version} to ${remote_version}"
|
||||
updates=true # Mark that updates are available
|
||||
fi
|
||||
@ -531,8 +603,6 @@ function zrep_update_package() {
|
||||
if [[ -n "$version" ]]; then
|
||||
local author="${specificPackage%%/*}"
|
||||
local script="${specificPackage#*/}"
|
||||
# local dlurl="${config[global_repo_url]}/download.php?a=${author}&s=${script}&v=${version}"
|
||||
# echo "Updating $specificPackage to version $version..."
|
||||
local install_pkg="${author}/${script}"
|
||||
zrep_install_package u ${install_pkg}
|
||||
else
|
||||
@ -541,8 +611,8 @@ function zrep_update_package() {
|
||||
else
|
||||
if [[ ${updates} == "true" ]]; then
|
||||
# Prompt the user only if updates are available
|
||||
echo "New updates are available. Do you want to proceed with updating? (Y/n): "
|
||||
read -q "response?"
|
||||
zrep_msg sub "New updates are available. Do you want to proceed with updating? (Y/n): \c"
|
||||
read "response"
|
||||
echo # Move to a new line
|
||||
|
||||
# Set the default response to 'Y' if no input is entered
|
||||
@ -550,17 +620,8 @@ function zrep_update_package() {
|
||||
|
||||
# Proceed with update if the response is 'Y' or 'y'
|
||||
if [[ $response =~ ^[Yy]$ ]]; then
|
||||
# General update mode: update all packages listed in updatesAvailable
|
||||
for package in ${(k)updatesAvailable}; do
|
||||
local author=${package%%/*}
|
||||
local script=${package#*/}
|
||||
local version=${updatesAvailable[${package}]}
|
||||
# local dlurl="${config[global_repo_url]}/download.php?a=${author}&s=${script}&v=${version}"
|
||||
|
||||
# echo "Preparing to update $package to version $version..."
|
||||
local install_pkg="${author}/${script}"
|
||||
zrep_install_package u ${install_pkg}
|
||||
done
|
||||
# Call zrep_process_updates to handle all updates.
|
||||
zrep_process_updates
|
||||
else
|
||||
zrep_msg info "Update canceled."
|
||||
fi
|
||||
@ -660,13 +721,15 @@ function zrep_install_package() {
|
||||
fi
|
||||
|
||||
# If not installed, proceed with fetching the package information
|
||||
zrep_parse_remote "${config[global_repo_url]}/packages.json\?$(date +%s)" "${package}"
|
||||
# Using the new zrep API to get the package version
|
||||
# zrep_parse_remote "${config[global_repo_url]}/getver.php\?p\=${package}" ${package}
|
||||
|
||||
local tmpDir="${config[main_zrep_install_dir]}/tmp"
|
||||
|
||||
mkdir -p "${tmpDir}"
|
||||
|
||||
local zipFile="${tmpDir}/${author}-${script}-${version}.zip"
|
||||
dlurl="${config[global_repo_url]}/download/${package}/${version}"
|
||||
zrep_download_package "${zipFile}" "${dlurl}"
|
||||
|
||||
unzip -q -o "${zipFile}" -d "${config[main_zrep_install_dir]}"
|
||||
@ -804,9 +867,10 @@ function zrep_help() {
|
||||
zrep_msg info " update (u) <author/package>:\t\t\tUpdate zrep package"
|
||||
zrep_msg info " enable <author/package>:\t\t\tEnable zrep package"
|
||||
zrep_msg info " disable <author/package>:\t\t\tDisable zrep package"
|
||||
zrep_msg info " search 'search term':\t\t\t\tSearch for authors, packages or description"
|
||||
zrep_msg info " version:\t\t\t\t\tDisplay zrep version"
|
||||
zrep_msg info " list:\t\t\t\t\t\tList installed packages"
|
||||
zrep_msg info " <author/package> help:\t\t\tDisplay help for pacakage (if available)"
|
||||
zrep_msg info " <author/package> help:\t\t\tDisplay help for package (if available)"
|
||||
|
||||
}
|
||||
|
||||
@ -859,6 +923,7 @@ function zrep_read_usage() {
|
||||
function main() {
|
||||
|
||||
zrep_main_version_string
|
||||
|
||||
if [[ ${1} != "init" ]]; then
|
||||
zrep_load_config ${1}
|
||||
zrep_load_theme ${config[global_theme]}
|
||||
@ -877,6 +942,9 @@ function main() {
|
||||
zrep_check_for_deps
|
||||
exit
|
||||
;;
|
||||
search | s | find)
|
||||
zrep_search "${@:2}"
|
||||
;;
|
||||
install | i)
|
||||
zrep_install_package ${2}
|
||||
;;
|
Reference in New Issue
Block a user