Compare commits

...

34 Commits
v0.8.1 ... main

Author SHA1 Message Date
Rob Muhlestein d51e7f3e87 deprecate 2024-11-23 00:15:21 -05:00
rwxrob 6b13675289
Add several updates 2022-01-27 16:17:09 -05:00
rwxrob 815089d968
Fix header titles 2021-12-25 12:15:54 -05:00
rwxrob 1806be55e7
Add Security disclaimer 2021-12-18 11:13:23 -05:00
rwxrob 32593202c6
Add basic color support 2021-12-16 00:22:08 -05:00
rwxrob b77c674962
Fix false return values for config (closes #8) 2021-12-15 23:19:22 -05:00
rwxrob 3d01d93246
Add check for function defined to delegation 2021-12-14 17:53:22 -05:00
rwxrob 0e70a1b471
Move _initialize and _conf_read above completion 2021-12-14 17:42:27 -05:00
rwxrob 39fa88375f
Fix jq _checkdep return 2021-09-15 13:49:51 -04:00
rwxrob 589f30327a
Add `_alternatives` hook and better `_initialize` 2021-09-08 10:06:25 -04:00
rwxrob 0ab6c359b1
Sort `config` output 2021-08-31 23:26:27 -04:00
rwxrob 0da6d1dfeb
Change `CONFIG` to `CONF` 2021-08-31 23:10:03 -04:00
rwxrob eedc4a7021
Move from `x_` to `x.` with explanation 2021-08-31 22:38:13 -04:00
rwxrob 159b2e78d7
Drop 'hidden' public commands
They are just too risky to promote because people might create
dependencies on them. Something is either exported and public or it's
not.
2021-08-31 22:00:16 -04:00
rwxrob 1070f958f7
Move `command_` (back) to `x_`, too verbose 2021-08-31 21:39:57 -04:00
rwxrob e3f8a5cc01
Fix single quote escapes 2021-08-31 09:54:18 -04:00
rwxrob 39e386700a
Add `_urlencode` and `_newest` and better docs 2021-08-31 09:47:57 -04:00
rwxrob dae44446b9
Add `value`, `keys`, `delete` to `config` 2021-08-29 12:19:03 -04:00
rwxrob 4228dcc7b9
Improve completion in-source comment 2021-08-27 13:15:05 -04:00
rwxrob f57eb1b80d
Fix position of `_read_config` and `_initialize` 2021-08-27 13:11:03 -04:00
rwxrob 77fcc9e6a9
Update `README.me` to describe hiding commands 2021-08-27 09:16:21 -04:00
rwxrob 4aabdc934c
Fix some line return `config` bugs 2021-08-26 10:00:16 -04:00
rwxrob d4cd7301f8
Add line return to `_config_get` if terminal 2021-08-26 09:48:11 -04:00
rwxrob 39d17d9234
Upgrade `_config_*` functions `config` command 2021-08-26 09:15:09 -04:00
rwxrob 7c67b896b7
Update README.md 2021-08-25 00:52:39 -04:00
rwxrob cc987dbc7a
Add `CONFIG_DIR` support to `config` command 2021-08-25 00:50:39 -04:00
rwxrob c426351e4e
Fix `_write_config` to take argument as well 2021-08-24 23:49:04 -04:00
rwxrob c90c3e1af0
Allow `_read_config` to take a path as argument 2021-08-23 23:13:45 -04:00
rwxrob 3acd8e9109
Fix bug with empty `values` file dumping line 2021-08-23 23:06:47 -04:00
rwxrob 5954cd7f97
Change no values file to non-fatal (return 0) 2021-08-23 22:59:58 -04:00
rwxrob 82af5adc4c
Fix rwxrob.tv link 2021-08-23 22:27:03 -04:00
rwxrob b33dbce025
Add `values` to `config` heading 2021-08-23 22:23:32 -04:00
rwxrob 8ee67139ff
Fix `config` title to `values` 2021-08-23 22:22:43 -04:00
rwxrob 3f003779db
Change `config` to `values` for a better name 2021-08-23 22:21:28 -04:00
2 changed files with 503 additions and 128 deletions

179
README.md
View File

@ -1,5 +1,11 @@
# Bash Template Command
*I no longer use this using [Bonzai][] instead. But it does have some good bash tricks to keep around including self-completion.*
[Bonzai]: <https://github.com/rwxrob/bonzai>
----
*This `README.md` is autogenerated.*
This is a GitHub template repo that will be copied instead of forked to
@ -11,17 +17,102 @@ gh repo create rwxrob/mycmd -p rwxrob/template-bash-command
This `cmd` inside can then be renamed and finished.
Obviously, not all of this is needed for many Bash scripts, but anything
with more than two subcommands will benefit from the builtin tab
completion, embedded Markdown help documentation support, and included
functions (`usage`, `_filter`, `_buffer`, `_have`, etc.)
## Naming Conventions
* Name repos containing single bash commands with `cmd-`
* Name template repos beginning with `template-`
* Start command functions with `command_` to be completed
* Start command functions with `command__` to not be completed
* Start command functions with `x.` to be completed
* Name `CONF` accessors with `x.` and full path
* Use dot (`.`) pathing in `CONF` key names
Think of `x` as in "executable" command.
> ⚠️
> Note that all versions of Vim current have a bug that does not allow
> dot (`.`) to be included in the function name even though it is
> explicitly allowed by bash. So you may have to add `.` to your
> `/usr/share/vim/vim82/syntax/sh.vim` file anywhere a function name
> expression is defined. I have yet to isolate it out and override it in
> my own `.vimrc`. It is a minimal edit.
## Builtins and Utilities
A number of builtin and frequently used utility functions have been
included for convenience. These save developers from adding other
moronic things like `sed` and `awk` subprocesses. Obviously, not all of
this is needed for many Bash scripts. Just remove what you do not need
or want.
### `_initialize`
The `_initialize` function is meant to contain initialization code and
be placed at the beginning of the script to be found easily even though
it is called at the bottom of the script (as bash requires). It is
passed the arguments that are passed to the script itself. This function can be omitted.
### `_alternatives`
The `_alternatives` function (usually placed after `_initialize`
provides a hook for dealing with alternative arguments to those that
identify commands (`x.*`). If the first argument to the script does not
match a command function then this function will be called before the
default `x.usage` command allowing shortcuts and other argument
alternatives and intelligent sensing of what command function is wanted
by simply examining the argument list. This can be useful when you wish
to provide shortcuts for longer commands but do not want to clutter the
command usage and completion list. For example, `zet dex.titles` could
be trapped in `_alternatives` to call `zet titles`.
### `_have`
Returns true (0) if the first argument exists as an executable in the
current `PATH`. Otherwise, return false (1).
### `_checkdep`
Checks that the first argument exists as an executable in the current
`PATH`. If so, returns true (0). If not, prints a generic error message
in English and returns false (1). The "progressive enhancement" design
principle requires minimal functionality using what is available and
progressively upgrading based on what is detected.
### `_newest`
Uses `ls` to return the newest file or directory in the specified
directory.
### `_trim`
Removes all whitespace (`[:space:]`) from the beginning and ending
of a string without invoking a subprocess.
### `_filter`
Reads the first argument or each line of standard input passing
each individually as the first argument to the calling function one at
a time. The UNIX philosophy requires all commands be filters whenever possible.
### `_buffer`
Reads the first argument or all lines of standard input and then
passes them to the calling function as the first argument. The UNIX philosophy requires all command be filters whenever possible.
### `_reduce`
Takes the name of an array and a bash extended regular expression
and prints only the array entries that match, one to a line suitable for
converting back into an array with `IFS=$'\n'` or just as an in-memory
`grep` replacement.
### `_jsonstr`
Encodes first argument or all standard input into a single line of JSON text. This function depends on the `jq` command.
### `_urlencode`
Encodes the first argument or all standard input using standard URL
encoding suitable for passing to `curl` or whatever. This function has
no external dependencies.
## Dependencies
@ -36,7 +127,7 @@ Optional:
## Justification
Bash is the dominate shell scripting language and the official default
Bash is the dominant shell scripting language and the official default
Linux interactive shell, which reduces cognitive overhead; every command
line *is* a line of code that could be put into script as is. Bash
scripts are at the core of cloud, containers, and Kubernetes. Bash 4+
@ -60,11 +151,17 @@ more powerful, safer, flexible, and performant than POSIX shell or Zsh.
[`shellcheck`]: <https://www.shellcheck.net>
## Security
This script is expected to be installed for a specific user and only
ever run by that user. No additional security vetting for running as an
untrusted user has been done.
## Legal
Copyright 2021 Rob Muhlestein <rob@rwx.gg>
Released under Apache-2.0 License
Please mention <https://rwxrob.tv>
Please mention rwxrob.tv
## The `bar` Command
@ -80,28 +177,56 @@ Bar the things.
cmd config
cmd config KEY
cmd config KEY VALUE
cmd config KEY ""
cmd config keys
cmd config val[ues]
cmd config dir[ectory]
cmd config path [file]
cmd config edit [file]
cmd config del[ete]
```
The `config` command is for reading, writing, and displaying standard
open desktop configurations properties.
open desktop configuration properties. Pass an empty string to delete
a property.
### Arguments
With no arguments outputs all the currently cached configuration
settings.
settings.
With a single KEY argument fetches the value for that key and outputs
it.
it unless it is one of the following special (reserved) key names:
* `dir*` full path to config directory
* `path` full path to specific config file (default: `values`)
* `edit` opens config file in editor (default: `editor` or `$EDITOR)
* `keys` output the configuration keys, one per line
* `val*` output the configuration values, one per line
* `del*` if key argument then delete a specific key, otherwise prompt
With more than one argument the remaining arguments after the KEY will
be combined into the VALUE and written to the `config` file in the
standard configuration home location (Search for `XDG_CONFIG_HOME` for
more information).
be combined into the VALUE and written to a `values` file in the
configuration directory.
### Configuration `config` File Format
### Configuration Directory
The file (which is always named `config` and almost always located at
`~/.config/cmd/config`) uses the simplest possible format to
The configuration directory path relies on the following environment
variables:
* `EXE` - defaults to name of currently running command (cmd)
* `HOME` - checked for `$HOME/.config/$EXE/values`
* `XDG_CONFIG_HOME` - overrides `$HOME/.config`
* `CONFIG_DIR` - full path to directory containing `values` file
The `CONFIG_DIR` always takes priority over anything else if set, but is
never implied. If the directory does not exist it will be created the
first time a value is set.
### Configuration `values` File Format
The file (which is almost always located at
`~/.config/cmd/values`) uses the simplest possible format to
facilitate standard UNIX parsing and filtering with any number of
existing tools (and no `jq` dependency).
@ -133,18 +258,6 @@ to `$PAGER` (default: more).
Also see `readme` and `usage` commands.
## Convert to JSON String
```
cmd json STRING
cmd json <<< STRING
cmd json < FILE
cmd json < <(COMMAND)
```
Converts input into JSON string using `jq` (if found) containing only
escaped (`\n`) line returns.
## Generate `README.md` File
```
@ -155,11 +268,15 @@ The `readme` command will output the embedded help documentation in raw
GitHub Flavored Markdown suitable for use as a `README.md` file on
GitHub or similar hosting service.
## The `some.config.setting` Command
Get and set `some.config.setting`.
## The `usage` Command
Displays a summary of usage.
----
*Autogenerated Mon Aug 23 10:14:22 PM EDT 2021*
*Autogenerated Sat Dec 18 11:13:17 AM EST 2021*

452
cmd
View File

@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# shellcheck disable=SC2016
set -e
# export PATH="/bin:/usr/bin:/usr/local/bin" # safer, if you can
@ -9,10 +9,30 @@ set -e
: "${EDITOR:=vi}"
: "${HELP_BROWSER:=}"
: "${EXE:="${0##*/}"}"
: "${XDG_CONFIG_HOME:="$HOME/.config"}"
declare -A HELP
declare -A CONFIG
declare -A CONF
# declare black=$'\e[30m'
# declare red=$'\e[31m'
# declare green=$'\e[32m'
# declare yellow=$'\e[33m'
# declare blue=$'\e[34m'
# declare magenta=$'\e[35m'
# declare cyan=$'\e[36m'
# declare white=$'\e[37m'
# declare reset=$'\e[0m'
_initialize() {
: # put initialization code here
}
_alternatives() {
# put alternative argument possibilities here
if [[ $CMD = f ]];then
x.foo "$@"
fi
}
HELP[main]='
# Bash Template Command
@ -28,17 +48,102 @@ gh repo create rwxrob/mycmd -p rwxrob/template-bash-command
This `cmd` inside can then be renamed and finished.
Obviously, not all of this is needed for many Bash scripts, but anything
with more than two subcommands will benefit from the builtin tab
completion, embedded Markdown help documentation support, and included
functions (`usage`, `_filter`, `_buffer`, `_have`, etc.)
## Naming Conventions
* Name repos containing single bash commands with `cmd-`
* Name template repos beginning with `template-`
* Start command functions with `command_` to be completed
* Start command functions with `command__` to not be completed
* Start command functions with `x.` to be completed
* Name `CONF` accessors with `x.` and full path
* Use dot (`.`) pathing in `CONF` key names
Think of `x` as in "executable" command.
> ⚠️
> Note that all versions of Vim current have a bug that does not allow
> dot (`.`) to be included in the function name even though it is
> explicitly allowed by bash. So you may have to add `.` to your
> `/usr/share/vim/vim82/syntax/sh.vim` file anywhere a function name
> expression is defined. I have yet to isolate it out and override it in
> my own `.vimrc`. It is a minimal edit.
## Builtins and Utilities
A number of builtin and frequently used utility functions have been
included for convenience. These save developers from adding other
moronic things like `sed` and `awk` subprocesses. Obviously, not all of
this is needed for many Bash scripts. Just remove what you do not need
or want.
### `_initialize`
The `_initialize` function is meant to contain initialization code and
be placed at the beginning of the script to be found easily even though
it is called at the bottom of the script (as bash requires). It is
passed the arguments that are passed to the script itself. This function can be omitted.
### `_alternatives`
The `_alternatives` function (usually placed after `_initialize`
provides a hook for dealing with alternative arguments to those that
identify commands (`x.*`). If the first argument to the script does not
match a command function then this function will be called before the
default `x.usage` command allowing shortcuts and other argument
alternatives and intelligent sensing of what command function is wanted
by simply examining the argument list. This can be useful when you wish
to provide shortcuts for longer commands but do not want to clutter the
command usage and completion list. For example, `zet dex.titles` could
be trapped in `_alternatives` to call `zet titles`.
### `_have`
Returns true (0) if the first argument exists as an executable in the
current `PATH`. Otherwise, return false (1).
### `_checkdep`
Checks that the first argument exists as an executable in the current
`PATH`. If so, returns true (0). If not, prints a generic error message
in English and returns false (1). The "progressive enhancement" design
principle requires minimal functionality using what is available and
progressively upgrading based on what is detected.
### `_newest`
Uses `ls` to return the newest file or directory in the specified
directory.
### `_trim`
Removes all whitespace (`[:space:]`) from the beginning and ending
of a string without invoking a subprocess.
### `_filter`
Reads the first argument or each line of standard input passing
each individually as the first argument to the calling function one at
a time. The UNIX philosophy requires all commands be filters whenever possible.
### `_buffer`
Reads the first argument or all lines of standard input and then
passes them to the calling function as the first argument. The UNIX philosophy requires all command be filters whenever possible.
### `_reduce`
Takes the name of an array and a bash extended regular expression
and prints only the array entries that match, one to a line suitable for
converting back into an array with `IFS=$'"'\\\n'"'` or just as an in-memory
`grep` replacement.
### `_jsonstr`
Encodes first argument or all standard input into a single line of JSON text. This function depends on the `jq` command.
### `_urlencode`
Encodes the first argument or all standard input using standard URL
encoding suitable for passing to `curl` or whatever. This function has
no external dependencies.
## Dependencies
@ -53,7 +158,7 @@ Optional:
## Justification
Bash is the dominate shell scripting language and the official default
Bash is the dominant shell scripting language and the official default
Linux interactive shell, which reduces cognitive overhead; every command
line *is* a line of code that could be put into script as is. Bash
scripts are at the core of cloud, containers, and Kubernetes. Bash 4+
@ -77,15 +182,21 @@ more powerful, safer, flexible, and performant than POSIX shell or Zsh.
[`shellcheck`]: <https://www.shellcheck.net>
## Security
This script is expected to be installed for a specific user and only
ever run by that user. No additional security vetting for running as an
untrusted user has been done.
## Legal
Copyright 2021 Rob Muhlestein <rob@rwx.gg>
Released under Apache-2.0 License
Please mention <https://rwxrob.tv>'
Please mention rwxrob.tv'
HELP[foo]='Foos things.'
command_foo() {
x.foo () {
_filter "$@" && return $?
echo "would foo: $*"
}
@ -98,37 +209,33 @@ HELP[bar]='
Bar the things.'
command_bar() {
x.bar() {
_buffer "$@" && return $?
echo "would bar: $*"
}
HELP[json]='
## Convert to JSON String
HELP[some.config.setting]='Get and set `some.config.setting`.'
```
'"$EXE"' json STRING
'"$EXE"' json <<< STRING
'"$EXE"' json < FILE
'"$EXE"' json < <(COMMAND)
```
Converts input into JSON string using `jq` (if found) containing only
escaped (`\\n`) line returns.'
command_json() { _jsonstr "$@"; }
command__hidden() {
_filter "$@" && return $?
echo "would run _hidden: $*"
x.some.config.setting() {
x.config some.config.setting "$@"
}
# ------------------ builtin commands and functions ------------------
# (https://github.com/rwxrob/template-bash-command)
############################## BOILERPLATE ###########################
## Everything from here to the end of file can be snipped and updated
## with latest from https://github.com/rwxrob/template-bash-command.
HELP[usage]='Displays a summary of usage.'
# ------------------------------- usage ------------------------------
command_usage() {
HELP[usage]='
```
'"$EXE"' usage
```
Display all possible commands. Note that this is usually easier by
simply using tab completion instead.'
x.usage() {
local -a cmds
for c in "${COMMANDS[@]}"; do
[[ ${c:0:1} =~ _ ]] && continue
@ -138,6 +245,8 @@ command_usage() {
printf "usage: %s (%s)\n" "$EXE" "${cmds[*]}"
}
# ------------------------------- help -------------------------------
HELP[help]='
```
@ -155,18 +264,20 @@ to `$PAGER` (default: more).
Also see `readme` and `usage` commands.
'
command_help() {
local name="${1:-main}" title body
x.help() {
local name="${1:-main}" title body file
title=$(_help_title "$name") || true
if [[ -z "$title" ]]; then
body="${HELP[$name]}"
title="$EXE $name"
[[ $name = main ]] && title="$EXE"
[[ $name == main ]] && title="$EXE"
fi
if [[ $name == main ]]; then
body=$(x.readme)
body=${body#*$title}
else
body="${HELP[$name]}"
body=${body#*$title}
fi
local file="/tmp/help-$EXE-$name.html"
file="/tmp/help-$EXE-$name.html"
if _have pandoc ; then
if _have "$HELP_BROWSER" && [[ -t 1 ]] ;then
pandoc -f gfm -s --metadata title="$title" \
@ -181,6 +292,18 @@ command_help() {
echo -e "$title\n\n$body" | "$PAGER"
}
_help_title() {
_filter "$@" && return $?;
local name="$1"
while IFS= read -r line; do
[[ $line =~ ^[:space]*$ ]] && continue
[[ $line =~ ^#\ (.+) ]] && echo "${BASH_REMATCH[1]}" && return 0
return 1
done <<< "${HELP[$name]}"
}
# ------------------------------ readme ------------------------------
HELP[readme]='
## Generate `README.md` File
@ -192,7 +315,7 @@ The `readme` command will output the embedded help documentation in raw
GitHub Flavored Markdown suitable for use as a `README.md` file on
GitHub or similar hosting service.'
command_readme() {
x.readme() {
_trim "${HELP[main]}"
echo
while IFS= read -r name; do
@ -204,34 +327,69 @@ command_readme() {
echo -e "----\n\n*Autogenerated $(date)*\n"
}
# ------------------------------ config ------------------------------
HELP[config]='
```
'"$EXE"' config
'"$EXE"' config KEY
'"$EXE"' config KEY VALUE
'"$EXE"' config.set KEY VALUE
'"$EXE"' config.set KEY ""
'"$EXE"' config.keys
'"$EXE"' config.values
'"$EXE"' config.directory
'"$EXE"' config.path [file]
'"$EXE"' config.edit [file]
'"$EXE"' config.delete
'"$EXE"' config.read
'"$EXE"' config.write
'"$EXE"' config.dump
```
The `config` command is for reading, writing, and displaying standard
open desktop configurations properties.
open desktop configuration properties.
### Arguments
With no arguments outputs all the currently cached configuration
settings.
With no arguments calls `dump` and outputs all the currently cached
configuration settings.
With a single KEY argument fetches the value for that key and outputs
it.
it unless it is one of the following special (reserved) key names:
* `directory` full path to config directory
* `path` full path to specific config file (default: `values`)
* `edit` opens config file in editor (default: `editor` or `$EDITOR)
* `keys` output the configuration keys, one per line
* `values` output the configuration values, one per line
* `delete` if key argument then delete a specific key, otherwise prompt
* `read` reads the configuration file into CONF associative array
* `write` write the CONF associative array to the configuration file
* `dump` write the flattened CONF associative array to standard output
With more than one argument the remaining arguments after the KEY will
be combined into the VALUE and written to the `config` file in the
standard configuration home location (Search for `XDG_CONFIG_HOME` for
more information).
be combined into the VALUE and written to a `values` file in the
configuration directory.
### Configuration `config` File Format
### Configuration Directory
The file (which is always named `config` and almost always located at
`~/.config/'"$EXE"'/config`) uses the simplest possible format to
The configuration directory path relies on the following environment
variables:
* `EXE` - defaults to name of currently running command ('"$EXE"')
* `HOME` - checked for `$HOME/.config/$EXE/values`
* `XDG_CONFIG_HOME` - overrides `$HOME/.config`
* `CONFIG_DIR` - full path to directory containing `values` file
The `CONFIG_DIR` always takes priority over anything else if set, but is
never implied. If the directory does not exist it will be created the
first time a value is set.
### Configuration `values` File Format
The file (which is almost always located at
`~/.config/'"$EXE"'/values`) uses the simplest possible format to
facilitate standard UNIX parsing and filtering with any number of
existing tools (and no `jq` dependency).
@ -239,53 +397,126 @@ existing tools (and no `jq` dependency).
* KEYs may be anything but the equal sign (`=`)
* VALUEs may be anything but line returns must be escaped
Note that this is *not* the same as Java properties and other similar
format. It is designed for ultimate simplicity, efficiency, and
portability.'
Note that, although similar, this is *not* the same as Java properties
and other similar format. It is designed for ultimate simplicity,
efficiency, and portability.'
command_config() {
x.config() {
case $# in
0) _dump_config ;;
1) printf "${CONFIG[$1]}" ;;
*) _set_config "$@" ;;
0) x.config.dump ;;
1) x.config.get "$@" ;;
*) x.config.set "$@" ;;
esac
}
_help_title() {
_filter "$@" && return $?;
local name="$1"
while IFS= read -r line; do
[[ $line =~ ^[:space]*$ ]] && continue
[[ $line =~ ^#\ (.+) ]] && echo "${BASH_REMATCH[1]}" && return 0
return 1
done <<< "${HELP[$name]}"
x.config.edit() {
: "${CONF[editor]:="${EDITOR:=vi}"}"
exec "${CONF[editor]}" "$(x.config.path "${1:-values}")"
}
_set_config() {
x.config.delete() {
if [[ -z "$1" ]];then
select key in "${!CONF[@]}"; do
x.config.delete "$key"
return $?
done
fi
x.config.set "$1" ''
}
x.config.keys() { printf "%s\n" "${!CONF[@]}"; }
x.config.values() { printf "%s\n" "${CONF[@]}"; }
x.config.dir() {
local dir="$HOME/.config/$EXE"
[[ -n "$XDG_CONFIG_HOME" ]] && dir="$XDG_CONFIG_HOME/$EXE"
[[ -n "$CONFIG_DIR" ]] && dir="$CONFIG_DIR"
[[ -n "$1" ]] && echo "$dir/$1" && return 0
printf "%s" "$dir"
[[ -t 1 ]] && echo
return 0
}
x.config.path() {
local file=${1:-values}
printf "%s/%s" "$(x.config.dir)" "$file"
[[ -t 1 ]] && echo
return 0
}
x.config.set() {
local key="$1"; shift; local val="$*"
val="${val//$'\n'/\\n}"
CONFIG["$key"]="$val"
_write_config
CONF["$key"]="$val"
x.config.write
}
_read_config() {
local path="$XDG_CONFIG_HOME/$EXE/config"
x.config.get() {
printf "%s" "${CONF[$1]}"
[[ -t 1 ]] && echo
return 0
}
x.config.read() {
local values="$(x.config.path)"
[[ -r "$values" ]] || return 0
while IFS= read -r line; do
[[ $line =~ ^([^=]+)=(.+)$ ]] || continue
CONFIG["${BASH_REMATCH[1]}"]="${BASH_REMATCH[2]}"
done < "$path"
CONF["${BASH_REMATCH[1]}"]="${BASH_REMATCH[2]}"
done < "$values"
}
_write_config() {
local path="$XDG_CONFIG_HOME/$EXE/config"
mkdir -p "${path%/config}"
_dump_config > "$path"
x.config.write() {
local dir="$(x.config.dir)"
mkdir -p "$dir"
x.config.dump > "$dir/values"
}
_dump_config() {
x.config.dump() {
(( ${#CONF[@]} == 0 )) && return 0
paste -d=\
<(printf "%s\n" "${!CONFIG[@]}") \
<(printf "%s\n" "${CONFIG[@]}")
<(printf "%s\n" "${!CONF[@]}") \
<(printf "%s\n" "${CONF[@]}") \
| sort
}
# ----------------------------- utilities ----------------------------
_jsonstr() {
_checkdep jq || return $?
_buffer "$@" && return $?
jq -MRsc <<< "$1"
}
_urlencode() {
_buffer "$@" && return $?
local string="$1"
local strlen=${#string}
local encoded=""
local pos c o
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"
}
_reduce() {
local -n name="${1:?"name of array required"}"
while IFS= read -r key; do
[[ $key =~ $2 ]] && echo "$key"
done < <(printf "%s\n" "${name[@]}")
}
_newest() {
IFS=$'\n'
mapfile -t f < <(ls -1 --color=never -trd "${1:-.}"/* 2>/dev/null)
[[ ${#f} > 0 ]] && echo "${f[-1]}"
}
_trim() {
@ -293,13 +524,16 @@ _trim() {
echo -e "${it%"${it##*[![:space:]]}"}"
}
_jsonstr() {
_buffer "$@" && return $?
jq -MRsc <<< "$1"
}
_join() { local IFS="$1"; shift; echo "$*"; }
_have(){ type "$1" &>/dev/null; }
_checkdep() {
_have "$1" && return 0
echo "'$EXE' depends on '$1' for this, but not found"
return 1
}
_filter(){
[[ -n "$1" ]] && return 1
while IFS= read -ra args; do
@ -312,12 +546,32 @@ _buffer() {
"${FUNCNAME[1]}" "$(</dev/stdin)"
}
_prompt() {
local key="$1" def="$2" regx="$3" value first=yes
shift 3
local text="${*:-Enter value for %s [%s]: }"
[[ -z "$key" ]] && echo "Missing prompt key" >&2 && return 1
[[ -z "$regx" ]] && echo "Missing valid regx" >&2 && return 1
while [[ ! $value =~ $regx ]];do
printf "$text" "$key" "$def" >&2
IFS= read -r value
[[ -z "$value" ]] && value="$def"
[[ $value =~ ^\ +$ ]] && value=""
[[ -n "$first" ]] && unset first && continue
echo "Must match /$regx/" >&2
done
_trim "$value"
}
# --------------------- completion and delegation --------------------
# (better than . <(foo bloated_completion) in .bashrc)
# `complete -C foo foo` > `source <(foo bloated_completion)`
x.config.read
_have _initialize && _initialize "$@"
while IFS= read -r line; do
[[ $line =~ ^declare\ -f\ command_ ]] || continue
COMMANDS+=( "${line##declare -f command_}" )
[[ $line =~ ^declare\ -f\ x\. ]] || continue
COMMANDS+=( "${line##declare -f x.}" )
done < <(declare -F)
mapfile -t COMMANDS < \
<(LC_COLLATE=C sort < <(printf "%s\n" "${COMMANDS[@]}"))
@ -325,28 +579,32 @@ mapfile -t COMMANDS < \
if [[ -n $COMP_LINE ]]; then
line=${COMP_LINE#* }
for c in "${COMMANDS[@]}"; do
[[ ${c:0:${#line}} == "${line,,}" && ${c:0:1} != _ ]] && echo "$c"
[[ ${c:0:${#line}} == "${line,,}" ]] && echo "$c"
done
exit
fi
for c in "${COMMANDS[@]}"; do
if [[ $c == "$EXE" ]]; then
"command_$EXE" "$@"
"x.$EXE" "$@"
exit $?
fi
done
_read_config
if [[ -n "$1" ]]; then
declare cmd="$1"; shift
declare CMD="$1"; shift
for c in "${COMMANDS[@]}"; do
if [[ $c == "$cmd" ]]; then
"command_$cmd" "$@"
declare cmd=$(command -v "x.$c")
if [[ $c == "$CMD" && -n "$cmd" ]]; then
"x.$CMD" "$@"
exit $?
fi
done
fi
command_usage "$@"
if _have _alternatives; then
_alternatives "$@"
exit $?
fi
x.usage "$@"