Starship Development Tools #3505
Unanswered
chipbuster
asked this question in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The tooling around starship development seems to have gotten more complex since the inception of the project. In addition, there are often tools that are very helpful to have while working with starship, but are not required. I figured it would be good to collect these in one place.
This initial post will be about required tools and will be updated as necessary. Feel free to add your own followups about tools you've found to be useful while developing starship.
TL;DR
To install all mandatory Rust toolchains, run the following commands:
Additionally, if you want to preview documentation locally, you will need npm, which you can install via a package manager, direct download, or by installing a node version manager.
Required Tools
Rust Development
In order to develop starship, you will need a functioning cargo toolchain. The most popular way to install this is via rustup.rs, by running the following code:
You will then need to run the following commands to get a stable toolchain with the required components:
Code Formatting
We use dprint to format most files in the repository. Install it with
Documentation
(Only required if you want to preview changes locally).
Documentation is built using npm. We recommend installing npm from your package manager. If you cannot do this, see links here for recommendations on how to install a node version manager. From there, follow the instructions in
CONTRIBUTING.md
.Beta Was this translation helpful? Give feedback.
All reactions