Display stylized feedback messages
Go to file
2021-08-09 19:23:37 -03:00
completions Initial commit 2021-08-07 19:20:31 -03:00
functions Initial commit 2021-08-07 19:20:31 -03:00
hooks Initial commit 2021-08-07 19:20:31 -03:00
completions.fish Initial commit 2021-08-07 19:20:31 -03:00
feedback.fish Initial commit 2021-08-07 19:20:31 -03:00
feedback_instructions.fish Initial commit 2021-08-07 19:20:31 -03:00
LICENSE Initial commit 2021-08-07 19:20:31 -03:00
README.md Updated README.md 2021-08-09 19:23:37 -03:00

GPL License Fish Shell Version Oh My Fish Framework

feedback

A plugin for Oh My Fish.

Display feedback and diagnostic messages - that is, messages that are printed to stderr and, as such, are not part of s program's output - stylized through control characters. Text placed between pipe characters, i.e. |, will be displayed in bold. Messages come in the following flavors:

  • win, a confirmation message.

  • wrn, a warning message.

  • err, an error message. It is a good practice to prefix your error message with the name of the command that failed, such as command: error message.

  • dim, a dimmed message. Commonly used to point out some activity in the background.

  • reg, a regular message.

Example Usage

asciicast

Syntax

[win/err/wrn/dim/reg] [-nsEeh] [MESSAGE]

Options

  • -o, overwrite current line.

  • -n, do not output a newline.

  • -s, do not separate arguments with spaces.

  • -E, disable interpretation of backslash escapes (default).

  • -e, enable interpretation of backslash escapes.

  • -h, display instructions.

Escape sequences

If -e is used, the following sequences are recognized:

  • \, backslash.

  • \a, alert (BEL).

  • \b, backspace.

  • \c, produce no further output.

  • \e, escape.

  • \f, form feed.

  • \n, new line.

  • \r, carriage return.

  • \t, horizontal tab.

  • \v, vertical tab.

  • \0NNN, byte with octal value NNN (1 to 3 digits).

  • \xHH, byte with hexadecimal value HH (1 to 2 digits).

Install

omf repositories add https://gitlab.com/argonautica/argonautica
omf install feedback

Dependencies

Plugin contains_opts. If not installed, it'll be installed together with feedback.