1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-23 01:17:59 +00:00
prezto/modules/helper/README.md
Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.

Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.

While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
2021-05-21 12:31:02 -05:00

874 B

Helper

Provides helper functions for developing modules.

Functions

  • add-zsh-trap adds a function name to a list to be called when a trap is triggered.
  • is-autoloadable checks if a file can be autoloaded by trying to load it in a subshell.
  • is-callable checks if a name is a command, function, or alias.
  • is-true checks a boolean variable for "true".
  • coalesce prints the first non-empty string in the arguments array.
  • is-darwin checks if running on macOS Darwin.
  • is-linux checks if running on Linux.
  • is-bsd checks if running on BSD.
  • is-cygwin checks if running on Cygwin (Windows).
  • is-termux checks if running on Termux (Android).

Authors

The authors of this module should be contacted via the issue tracker.