prezto/modules/helper/README.md

# 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][1]._

- [Sorin Ionescu](https://github.com/sorin-ionescu)

[1]: https://github.com/sorin-ionescu/prezto/issues
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://'). 2021-05-04 01:59:31 +00:00			`# Helper`
[Fix #120] Add documentation for trap 2012-06-12 19:35:47 +00:00
[Fix #249] Add documentation for helper 2012-09-08 23:21:00 +00:00			`Provides helper functions for developing modules.`
[Fix #120] Add documentation for trap 2012-06-12 19:35:47 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://'). 2021-05-04 01:59:31 +00:00			`## Functions`
[Fix #120] Add documentation for trap 2012-06-12 19:35:47 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://'). 2021-05-04 01:59:31 +00:00			- `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).
[Fix #120] Add documentation for trap 2012-06-12 19:35:47 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://'). 2021-05-04 01:59:31 +00:00			`## Authors`
[Fix #120] Add documentation for trap 2012-06-12 19:35:47 +00:00
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-05 17:59:01 +00:00			`_The authors of this module should be contacted via the [issue tracker][1]._`
[Fix #120] Add documentation for trap 2012-06-12 19:35:47 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://'). 2021-05-04 01:59:31 +00:00			`- [Sorin Ionescu](https://github.com/sorin-ionescu)`
[Fix #120] Add documentation for trap 2012-06-12 19:35:47 +00:00
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv 2012-09-03 20:08:39 +00:00			`[1]: https://github.com/sorin-ionescu/prezto/issues`