Skip to content

spaceship-prompt/spaceship-vue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

𝗩 + πŸš€
Spaceship Vue

A Vue.js section for Spaceship prompt

GitHub Release GitHub Workflow Status Spaceship Twitter Chat on Discord

Current Vue version, from package.json file found in the closest node_modules/vue package (𝗩).

Installing

You need to source this plugin somewhere in your dotfiles. Here's how to do it with some popular tools:

Execute this command to clone this repo into Oh-My-Zsh plugin's folder:

git clone https://github.com/spaceship-prompt/spaceship-vue.git $ZSH_CUSTOM/plugins/spaceship-vue

Include spaceship-vue in Oh-My-Zsh plugins list:

plugins=($plugins spaceship-vue)
zplug "spaceship-prompt/spaceship-vue"
antigen bundle "spaceship-prompt/spaceship-vue"
antibody bundle "spaceship-prompt/spaceship-vue"
zinit light "spaceship-prompt/spaceship-vue"
zgen load "spaceship-prompt/spaceship-vue"
[plugins.spaceship-vue]
github = "spaceship-prompt/spaceship-vue"

Manual

If none of the above methods works for you, you can install Spaceship manually.

  1. Clone this repo somewhere, for example to $HOME/.zsh/spaceship-vue.
  2. Source this section in your ~/.zshrc.

Example

mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-vue.git "$HOME/.zsh/spaceship-vue"

For initializing prompt system add this to your .zshrc:

source "~/.zsh/spaceship-vue/spaceship-vue.plugin.zsh"

Usage

After installing, add the following line to your .zshrc in order to include Ember section in the prompt:

spaceship add vue

Options

This section is shown only in directories within a Vue context.

Variable Default Meaning
SPACESHIP_VUE_SHOW true Show current section
SPACESHIP_VUE_PREFIX $SPACESHIP_PROMPT_DEFAULT_PREFIX Prefix before section
SPACESHIP_VUE_SUFFIX $SPACESHIP_PROMPT_DEFAULT_SUFFIX Suffix after section
SPACESHIP_VUE_SYMBOL 𝗩 Character to be shown before version
SPACESHIP_VUE_COLOR 114 Color of section

Contributing

First, thanks for your interest in contributing!

Contribute to this repo by submitting a pull request. Please use conventional commits, since this project adheres to semver and is automatically released via semantic-release.

License

MIT Β© Denys Dovhan and Juha Sarkkinen