diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8871b7c..04c6bbd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,12 +88,12 @@ const plugin: Fig.Plugin = { displayName: "My New Plugin", github: "withfig/my-new-plugin", description: "A one-line description of what this plugin does", - screenshots: ["images/example.png", "images/another-example.png"] + screenshots: ["images/example.png", "images/another-example.png"], shells: ["zsh"], authors: [ { name: "Fig", twitter: "@fig", github: "withfig"}] - /* ... */ + /* ... */ } export default plugin; ``` diff --git a/plugins/starship/README.md b/plugins/starship/README.md new file mode 100644 index 0000000..0920cb3 --- /dev/null +++ b/plugins/starship/README.md @@ -0,0 +1,126 @@ +

+ Starship โ€“ Cross-shell prompt +

+ +

+ GitHub Actions workflow status + Crates.io version + Packaging status
+ Chat on Discord + Follow @StarshipPrompt on Twitter +

+ +

+ Website + ยท + Installation + ยท + Configuration +

+ + +[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine) + +

+ +Starship with iTerm2 and the Snazzy theme + +**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** + +- **Fast:** it's fast โ€“ _really really_ fast! ๐Ÿš€ +- **Customizable:** configure every aspect of your prompt. +- **Universal:** works on any shell, on any operating system. +- **Intelligent:** shows relevant information at a glance. +- **Feature rich:** support for all your favorite tools. +- **Easy:** quick to install โ€“ start using it in minutes. + +

+Explore the Starship docs  โ–ถ +

+ +## ๐Ÿ”ง Configuration + +Start a new shell instance, and you should see your beautiful new shell prompt. +If you're happy with the defaults, enjoy! + +If you're looking to further customize Starship: + +- **[Configuration](https://starship.rs/config/)** โ€“ learn how to configure Starship to tweak your prompt to your liking + +- **[Presets](https://starship.rs/presets/)** โ€“ get inspired by the pre-built configuration of others + +## ๐Ÿค Contributing + +We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/๐ŸŒฑ%20good%20first%20issue). + +If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). + +If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. ๐Ÿ‘‹ + +## ๐Ÿ’ญ Inspired By + +Please check out these previous works that helped inspire the creation of starship. ๐Ÿ™ + +- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** โ€“ A ZSH prompt for astronauts. + +- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** โ€“ Cross-shell robbyrussell theme written in JavaScript. + +- **[reujab/silver](https://github.com/reujab/silver)** โ€“ A cross-shell customizable powerline-like prompt with icons. + +

+
+ Starship rocket icon +

+ +## ๐Ÿ“ License + +Copyright ยฉ 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
+This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. + +[alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=starship +[arch linux community]: https://archlinux.org/packages/community/x86_64/starship +[chocolatey]: https://community.chocolatey.org/packages/starship +[conda-forge]: https://anaconda.org/conda-forge/starship +[copr]: https://copr.fedorainfracloud.org/coprs/atim/starship +[crates.io]: https://crates.io/crates/starship +[fedora packages]: https://src.fedoraproject.org/rpms/rust-starship +[freshports]: https://www.freshports.org/shells/starship +[gentoo packages]: https://packages.gentoo.org/packages/app-shells/starship +[linuxbrew]: https://formulae.brew.sh/formula/starship +[homebrew]: https://formulae.brew.sh/formula/starship +[macports]: https://ports.macports.org/port/starship +[nixpkgs]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix +[pkgsrc]: https://pkgsrc.se/shells/starship +[scoop]: https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json +[snapcraft]: https://snapcraft.io/starship +[termux]: https://github.com/termux/termux-packages/tree/master/packages/starship +[void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship diff --git a/plugins/starship/images/demo.gif b/plugins/starship/images/demo.gif new file mode 100644 index 0000000..26ff47c Binary files /dev/null and b/plugins/starship/images/demo.gif differ diff --git a/plugins/starship/images/icon.svg b/plugins/starship/images/icon.svg new file mode 100644 index 0000000..078172c --- /dev/null +++ b/plugins/starship/images/icon.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/plugins/starship/index.ts b/plugins/starship/index.ts new file mode 100644 index 0000000..789cf67 --- /dev/null +++ b/plugins/starship/index.ts @@ -0,0 +1,47 @@ +const plugin: Fig.Plugin = { + name: "starship", + displayName: "Starship", + github: "starship/starship", + description: + "The minimal, blazing-fast, and infinitely customizable prompt for any shell!", + icon: "images/icon.svg", + screenshots: ["images/demo.gif"], + site: "https://starship.rs", + docs: "https://starship.rs/config/", + twitter: "StarshipPrompt", + license: ["ISC"], + authors: [{ name: "Matan Kushner", twitter: "@matchai", github: "matchai" }], + shells: ["bash", "zsh", "fish"], + categories: ["Prompt"], + + installation: { + origin: "github", + onInstall: { + command: [ + "curl -sS https://starship.rs/install.sh | sh -s -- --yes --bin-dir=$HOME/.local/bin", + ], + check: { + commandExists: ["starship"], + commandOutput: [ + { + command: "starship module character", + output: "[1;32mโฏ ", + }, + ], + }, + }, + onUninstall: { + file: ["~/.local/bin/starship"], + }, + bash: { + postScript: 'eval "$(starship init bash)"', + }, + fish: { + postScript: "starship init fish | source", + }, + zsh: { + postScript: 'eval "$(starship init zsh)"', + }, + }, +}; +export default plugin;