Fishline v3.0.0

[0rax]

Description

This new version of fishline consist of a complete refactoring of the code base to elevate a lot of internal feature of fish that were left aside originally. Its also contains some small changes to be compatible with the new 2.3.0 version of fish.

Changelog

Breaking changes

• Initialization script is now name init.fish instead of fishline.fish in order to be compatible with plugin managers such as fisherman. When upgrading from fishline v2 you will need to update your loading script for fishline (see the Installation section of this comment).
• Theme symbols FLSYM_{LEFT,RIGHT}_PRE and FLSYM_{LEFT,RIGHT}_POST have been moved around to make way more sense. PRE is now used when a segment opens and POST when it closes. PRE and POST are now named around the segment it belongs to and not the separator as previously. This can break themes that were using those symbols and values for those variables should be swapped around.

Major changes

• Initialization script now elevate fish function autoloading instead of loading everything itself. This makes the initialization script faster. It also makes segment modifications and new segment load automatically.
• The entire code base has been refactor to be more idiomatic.
  • The only exposed function is now fishline
  • All internals and segments are now prefixed by a __ making them show as private function (i.e not shown when listing functions using functions)
  • Segment and tests are now separated in 2 different files (segments/__flseg_segment & tests/fltest_segment)
  • Segment names are now written in snake_case and expose a function named __flseg_segment_name in a file with the same name (necessary for fish autoloading).
  • All internals have also been renamed in snake_case with the private __fishline_ prefix instead of publicly exported FLINT_
  • Tests are no longer loaded by initialization script and are only available when specifically sourced or when using tests/run.fish
• Segment names when calling fishline are now case insensitive (for backward compatibility)
• Add sensible default depending on system info
  • themes/tty_compatible.fish will be loaded by default when fishline init's detect its running in a tty
  • themes/default_ansi_colors.fish or themes/default_256_colors.fish will be loaded depending on tput colors output
  • default 256 colors theme has also been updated and is now different from previous version (old color theme is still available as themes/legacy_256_colors.fish)
• Segment symbols are now stored in a theme file instead of the segment files itself (easier for theming)
• Added new internal __fishline_segment_close (cleaner that using an optional argument to __fishline_segment)
• New segment separator that just creates an empty segment
• New segment fish that prints a goldfish in your prompt
• New segment invert that will invert the next segments opening (allowing to create diamond shaped instead of arrow shaped segment)

Minor changes

• Update vimode segment to be compatible with fish v2.3.0
• Update pwd segment to use prompt_pwd function instead of pwd directly as fish v2.3.0 now permit customization of abbrev length
  • Using fish_prompt_pwd_dir_length you can now specify directory abbreviation length for this segment and prompt_pwd in general
• Add small help and small util options to fishline function
  • fishline -h shows a small usage for fishline
  • fishline -x lists all available segment
  • fishline -v show fishline version
• tests/run.fish now have a small help, does not run all tests by default & can load themes for you
  • tests/run.fish -h show a small usage for the test framework
  • tests/run.fish -t theme.fish asks the test framework to load a theme before runing tests
  • tests/run.fish -a runs all tests for all segments
  • tests/run.fish segment_name run tests for segment_name segment
• Some minor optimizations and modifications to internals

Documentation

The whole documentation requires an update to reflect the changes made by the big refactoring that this version consist. The wiki will see some drastic change in the near future in order to reflect all of it, the Development section will also finally be updated.

Installation

Upgrading

As stated before, the initialization script of fishline has been changed thus require you to change how you are loading fishline. When upgrading from fishline v2 you will need to update the section where you load fishline reflect this change. You will simply need to change:

  set FLINE_PATH $HOME/.config/fish/fishline
- source $FLINE_PATH/fishline.fish
+ source $FLINE_PATH/init.fish

You previous configuration should work exactly as it was with previous version (including fishline v1).

New installation

For a brand new installation, the README.md have all the necessary information required to install and configure fishline.

Using Fisherman

It is to note that this release adds the support for installing fishline using fisherman. It also add the possibility to share your fishline theme and configuration using this plugin manager (see 0rax/sharktooth for a simple example of how this could be done).

To install fishline using fisherman you will just need to run:

fisher i 0rax/fishline

You will then still need to create your own fish_prompt to use fishline for your prompt as we do not provide a default fish_prompt or fish_right_prompt by default. If you wish to install a default prompt & theme along with fishline see 0rax/sharktooth.

We know that some people may not like to use of a package manager to configure its shell (me included) and we want to make clear that fishline is made to work as a standalone prompt framework for fish and will never require you to use a third party software to install or manage it (except Git of course 😄).

[0rax]

Bugfixe required before merging

• sigstatus segment requires a modification to work with procps-ng kill (sigstatus segment breaks with procps-ng kill #21)
• git segment requires a modification to show the correct name for an orphaned branch