feat: add option to display exit pipe status

[Maritsu]

related: none

Adds an option to display the exit status if the last command failed. Includes an extra option to convert signal numbers (129 and above) to their respective names (SIGHUP, SIGINT, SIGQUIT, etc.), as well as two configuration options.

How to test pre-release?

☠️ Feature can be unstable and break your prompt!

fisher install Maritsu/pure@feature/display-exit-code
set --universal pure_show_exit_status true # Show non-zero statuses
set --universal pure_convert_exit_status_to_signal true # Convert signal numbers to names

Specs

New config in conf.d/pure.fish

_pure_set_default pure_show_exit_status false
_pure_set_default pure_convert_exit_status_to_signal false
_pure_set_default pure_symbol_exit_status_prefix "|"
_pure_set_default pure_symbol_exit_status_separator "|"
_pure_set_default pure_color_exit_status pure_color_danger

Documentation

Usage

• Enable feature:

❯ set --universal pure_show_exit_status true

• Enable signal number conversion:

❯ set --universal pure_convert_exit_status_to_signal true

Acceptance Checks

• Documentation is up-to-date:
  • Add entry in feature list of README.md ;
  • Add entry in features' overview in docs/ ;
  • Add section in feature list to document
    • Features' flag ;
    • Prompt symbol ;
• Default are defined in conf.d/pure.fish for:
  • Feature flag ;
  • Symbol ;
• Tests are passing (I can help you 🤗 ):
  • Config are tested (cf. tests/_pure.test.fish) ;
  • Feature is tested in tests/feature_name.test.fish ;
• Customization is available ;
• Feature is implemented.

[Maritsu]

Just pushed a fix for the failing test, sorry for having overlooked it!

[edouard-lopez]

Thanks for the PR!
Could you share some screenshots ?

I added some todo, will check again later as I’m not on a computer

[edouard-lopez]

Note: Variable $pipestatus was introduced in Fish 3.1b1, our minimal supported version is 3.3.1

[edouard-lopez]

Thought: I see you are limiting to POSIX-compliant UNIX systems codes. That’s fine by me, we can add more when use cases arise.

[Maritsu]

Much as I'd have liked that to be the case, I just pulled up the kernel manpage you linked and thought "I've never seen most of these statuses, I think 15 is going to be good enough" 😅

[Maritsu]

Thanks for the PR! Could you share some screenshots ?

sure thing, here you go :) i used my personal config; if you'd like me to retake them with the defaults, just say

[edouard-lopez]

Thanks for the screenshots.

Question: Did you get inspiration from another theme or tool ?
Thought: Did you try using a prefix to identify this segment? Like for python virtualenv or root context

[Maritsu]

Question: Did you get inspiration from another theme or tool ?

I learned of $pipestatus's existence by stumbling upon Hydro, but decided to stay close to the vanilla Fish prompt as far as the default configuration goes.

Thought: Did you try using a prefix to identify this segment? Like for python virtualenv or root context

Not really, I think the display is intuitive enough without any prefix but I could add one in if you wish.

[edouard-lopez]

Please add a pure_symbol_exit_status_prefix with a default value of "|", so new segment follow the same pattern (prefix then data).

[edouard-lopez]

I pushed a PR to update the doc about feature design based on our exchange #396

[Maritsu]

Please add a pure_symbol_exit_status_prefix with a default value of "|", so new segment follow the same pattern (prefix then data).

Done, here's how it looks now.