Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spaceship-prompt/spaceship-react
⚛ React section for Spaceship prompt
https://github.com/spaceship-prompt/spaceship-react
prompt react reactjs shell spaceship spaceship-prompt terminal zsh
Last synced: 22 days ago
JSON representation
⚛ React section for Spaceship prompt
- Host: GitHub
- URL: https://github.com/spaceship-prompt/spaceship-react
- Owner: spaceship-prompt
- License: mit
- Created: 2023-01-03T18:40:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-04T18:08:40.000Z (about 2 years ago)
- Last Synced: 2024-05-22T17:24:35.445Z (9 months ago)
- Topics: prompt, react, reactjs, shell, spaceship, spaceship-prompt, terminal, zsh
- Language: Shell
- Homepage:
- Size: 26.4 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
⚛ + 🚀
Spaceship React
A React section for Spaceship prompt
Current React version from `package.json` file found in the closest `node_modules/react` package (`⚛`).
## Installing
You need to source this plugin somewhere in your dotfiles. Here's how to do it with some popular tools:
### [Oh-My-Zsh]
Execute this command to clone this repo into Oh-My-Zsh plugin's folder:
```zsh
git clone https://github.com/spaceship-prompt/spaceship-react.git $ZSH_CUSTOM/plugins/spaceship-react
```
Include `spaceship-react` in Oh-My-Zsh plugins list:
```zsh
plugins=($plugins spaceship-react)
```
### [zplug]
```zsh
zplug "spaceship-prompt/spaceship-react"
```
### [antigen]
```zsh
antigen bundle "spaceship-prompt/spaceship-react"
```
### [antibody]
```zsh
antibody bundle "spaceship-prompt/spaceship-react"
```
### [zinit]
```zsh
zinit light "spaceship-prompt/spaceship-react"
```
### [zgen]
```zsh
zgen load "spaceship-prompt/spaceship-react"
```
### [sheldon]
```toml
[plugins.spaceship-react]
github = "spaceship-prompt/spaceship-react"
```
### 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-react`.
2. Source this section in your `~/.zshrc`.
### Example
```zsh
mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-react.git "$HOME/.zsh/spaceship-react"
```
For initializing prompt system add this to your `.zshrc`:
```zsh title=".zshrc"
source "~/.zsh/spaceship-react/spaceship-react.plugin.zsh"
```
## Usage
After installing, add the following line to your `.zshrc` in order to include React section in the prompt:
```zsh
spaceship add react
```
## Options
This section is shown only in directories within a React context.
| Variable | Default | Meaning |
| :----------------------- | :-------: | ------------------------------------ |
| `SPACESHIP_REACT_SHOW` | `true` | Show current section |
| `SPACESHIP_REACT_ASYNC` | `true` | Render section asynchronously |
| `SPACESHIP_REACT_PREFIX` | `via ` | Prefix before section |
| `SPACESHIP_REACT_SUFFIX` | ` ` | Suffix after section |
| `SPACESHIP_REACT_SYMBOL` | `⚛ ` | Character to be shown before version |
| `SPACESHIP_REACT_COLOR` | `cyan` | Color of section |
## Contributing
First, thanks for your interest in contributing!
Contribute to this repo by submitting a pull request. Please use [conventional commits](https://www.conventionalcommits.org/), since this project adheres to [semver](https://semver.org/) and is automatically released via [semantic-release](https://github.com/semantic-release/semantic-release).
## License
MIT © [Denys Dovhan](http://denysdovhan.com) and Ryan Jentzsch
[Oh-My-Zsh]: https://ohmyz.sh/
[zplug]: https://github.com/zplug/zplug
[antigen]: https://antigen.sharats.me/
[antibody]: https://getantibody.github.io/
[zinit]: https://github.com/zdharma/zinit
[zgen]: https://github.com/tarjoilija/zgen
[sheldon]: https://sheldon.cli.rs/