WIP: Breaking changes (order, colors, suffixes)

[denysdovhan]

Implementation of custom prompt ordering. See #71 for more information.

---

UPD: This PR is going to introduce the biggest internal changes since Spaceship's first release. Here's the list of changes:

• Better comments (file is divided by the section)
• _exists helper
• Custom ordering using $SPACESHIP_PROMPT_ORDER variable.
• Prefixes for time and user sections
• Suffixes options (exposed as $SPACESHIP_*_SUFFIX variables)
• Custom coloring (exposed as $SPACESHIP_*_COLOR variables)
• _prompt_section is used for drawing sections
• user, host and dir sections are standalone
• Internal functions are prefixes with _
• nvm → node ⬢ n support #70
• $SPACESHIP_NODE_DEFAULT_VERSION for default Node.js version What if the user don't use nvm? #33
• New, slightly better prompt character ➜ instead of ➔
• git -> git_branch + git_status with their own prefixes, suffixes and colors
•  is used as a git symbol (for visual difference with ☿ Mercurial support #54)
• Better installer
• Add uninstaller
• Installing via NPM
• Add .editorconfig

[salmanulfarzy]

Any update on when this will be merged?

[denysdovhan]

@sfarzy it's not ready yet. I'm working on it right now. Unfortunately, I don't have enough time to finish it :(

[salmanulfarzy]

Isn't this symbol from powerline fonts?

[denysdovhan]

It looks like this:

I've added this icon because it looks nice and it would be more obvious along with hg's icon.

[salmanulfarzy]

It looks great and many themes are using it. But don't go well with normal fonts. This is how it looks with some non-powerline fonts

Inconsolata Regular 12

DejaVu Sans Mono Book 12

Hack poweline 10

[denysdovhan]

That's why we have exposed it as $SPACESHIP_GIT_SYMBOL, so it could be replaced by anything else.

[salmanulfarzy]

Giving users a heads up will be nice. All other symbols are compatible with normal fonts, so now we are depending on powerline for a single symbol.

One suggestion is to use u2387 ( ⎇ ) instead of ue0a0 (  ). Which compatible with most fonts tested, even though it doesn't look good as the latter.

It's just a suggestion ignore if irrelevant.

[denysdovhan]

I've been experimenting a bit with new options and find out that Spaceship became highly customizible. Take a look at this:

GIF Preview:

Connected via SSH:

Here are my options:

# ORDER
SPACESHIP_PROMPT_ORDER=(
  time     #
  vi_mode  # these sections will be
  user     # before prompt char
  host     #
  char
  dir
  git
  node
  ruby
  xcode
  swift
  golang
  docker
  venv
  pyenv
)

# USER
SPACESHIP_USER_PREFIX="" # remove `with` before username
SPACESHIP_USER_SUFFIX="" # remove space before host

# HOST
# Result will look like this:
#   username@:(hostname)
SPACESHIP_HOST_PREFIX="@:("
SPACESHIP_HOST_SUFFIX=") "

# DIR
SPACESHIP_DIR_PREFIX='' # disable directory prefix, cause it's not the first section
SPACESHIP_DIR_TRUNC='1' # show only last directory

# GIT
# Disable git symbol
SPACESHIP_GIT_SYMBOL="" # disable git prefix
SPACESHIP_GIT_BRANCH_PREFIX="" # disable branch prefix too
# Wrap git in `git:(...)`
SPACESHIP_GIT_PREFIX='git:('
SPACESHIP_GIT_SUFFIX=") "
SPACESHIP_GIT_BRANCH_SUFFIX="" # remove space after branch name
# Unwrap git status from `[...]`
SPACESHIP_GIT_STATUS_PREFIX=""
SPACESHIP_GIT_STATUS_SUFFIX=""

# NODE
SPACESHIP_NODE_PREFIX="node:("
SPACESHIP_NODE_SUFFIX=") "
SPACESHIP_NODE_SYMBOL=""

# RUBY
SPACESHIP_RUBY_PREFIX="ruby:("
SPACESHIP_RUBY_SUFFIX=") "
SPACESHIP_RUBY_SYMBOL=""

# XCODE
SPACESHIP_XCODE_PREFIX="xcode:("
SPACESHIP_XCODE_SUFFIX=") "
SPACESHIP_XCODE_SYMBOL=""

# SWIFT
SPACESHIP_SWIFT_PREFIX="swift:("
SPACESHIP_SWIFT_SUFFIX=") "
SPACESHIP_SWIFT_SYMBOL=""

# GOLANG
SPACESHIP_GOLANG_PREFIX="go:("
SPACESHIP_GOLANG_SUFFIX=") "
SPACESHIP_GOLANG_SYMBOL=""

# DOCKER
SPACESHIP_DOCKER_PREFIX="docker:("
SPACESHIP_DOCKER_SUFFIX=") "
SPACESHIP_DOCKER_SYMBOL=""

# VENV
SPACESHIP_VENV_PREFIX="venv:("
SPACESHIP_VENV_SUFFIX=") "

# PYENV
SPACESHIP_PYENV_PREFIX="python:("
SPACESHIP_PYENV_SUFFIX=") "
SPACESHIP_PYENV_SYMBOL=""

Gonna share this setup in Presets wiki-page

[denysdovhan]

Hooray! 🎉